From 49e38337563de79ddd9ae3cf1b1ec9d1a2e28a6f Mon Sep 17 00:00:00 2001 From: Aidan Date: Tue, 8 Apr 2025 16:19:37 -0400 Subject: [PATCH] docs: add docs editing procedure+guidelines --- docs/_sidebar.md | 3 ++- docs/index.html | 2 +- docs/reference/editing-docs.md | 38 ++++++++++++++++++++++++++++++++++ 3 files changed, 41 insertions(+), 2 deletions(-) create mode 100644 docs/reference/editing-docs.md diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 8f70552..964bdc7 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -10,4 +10,5 @@ * Reference * [Environment Variables](reference/env.md) - * [Database Migration Guide](reference/db-migration.md) \ No newline at end of file + * [Database Migration Guide](reference/db-migration.md) + * [Editing Documentation](reference/editing-docs.md) \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index f9a1a95..7fff349 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,7 +2,7 @@ - Document + LibreCloud Docs diff --git a/docs/reference/editing-docs.md b/docs/reference/editing-docs.md new file mode 100644 index 0000000..d2e53f3 --- /dev/null +++ b/docs/reference/editing-docs.md @@ -0,0 +1,38 @@ +# Editing Documentation + +You can freely modify the LibreCloud documentation on our [repository](https://git.pontusmail.org/librecloud/web), in the `docs/` folder. We encourage contributions of all kinds! + +## Editing Guidelines + +- Have common sense, please. +- Obviously, this is not the place to rant about your political beliefs or spread hate. +- Test the instructions/docs you write, if possible. +- Yeah, just have common sense + +Just be sure to link your new pages in `docs/_sidebar.md` so people can find them! + +## Serving Docs + +You might want to serve the docs you've edited to see how they'll look on [docs.librecloud.cc](https://docs.librecloud.cc). No fear, Docsify is here! + +Do this with the `docsify-cli`, which can be installed like so: + +**Bun** + +```bash +# This will be installed globally +bun i docsify-cli -g +``` + +**NPM** + +```bash +# This will be installed globally +npm i docsify-cli -g +``` + +Finally, you can serve the docs with this command: + +```bash +docsify serve docs +``` \ No newline at end of file