docs: add docs editing procedure+guidelines

2025-04-08 16:19:37 -04:00 · 2025-04-08 16:19:37 -04:00 · 49e3833756
commit 49e3833756
parent 55d441c926
3 changed files with 41 additions and 2 deletions
--- a/docs/_sidebar.md
+++ b/docs/_sidebar.md
@ -11,3 +11,4 @@

    * [Environment Variables](reference/env.md)
    * [Database Migration Guide](reference/db-migration.md)
+    * [Editing Documentation](reference/editing-docs.md)
--- a/docs/index.html
+++ b/docs/index.html
@ -2,7 +2,7 @@
 <html lang="en">
 <head>
  <meta charset="UTF-8">
-  <title>Document</title>
+  <title>LibreCloud Docs</title>
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
  <meta name="description" content="Description">
  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
--- a/docs/reference/editing-docs.md
+++ 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
+```