summaryrefslogtreecommitdiff
path: root/Documentation/source/operations/documentation.rst
diff options
context:
space:
mode:
authorBertrand Yuan <me@bertyuan.com>2026-04-27 20:52:54 +0800
committerBertrand Yuan <me@bertyuan.com>2026-04-27 20:53:14 +0800
commitdbb5e791f0c228369605d126dd590962ebe1eddc (patch)
tree8c83fc84bd9547630e6733929dec77e102e055a8 /Documentation/source/operations/documentation.rst
parent658798b3a2378bb6df16cfbb16d707c6fb719e1e (diff)
docs: add comprehensive documentation for operations
This commit introduces a complete set of documentation files covering various aspects of the project, including environment setup, quality checks, command references, and architecture. The documentation is structured to assist developers and contributors in understanding the project's configuration, workflow, and best practices. Additionally, translations for Simplified and Traditional Chinese have been added to ensure accessibility for a wider audience. This enhances the overall usability and maintainability of the project. Signed-off-by: Bertrand Yuan <github@bertyuan.com>
Diffstat (limited to 'Documentation/source/operations/documentation.rst')
-rw-r--r--Documentation/source/operations/documentation.rst51
1 files changed, 51 insertions, 0 deletions
diff --git a/Documentation/source/operations/documentation.rst b/Documentation/source/operations/documentation.rst
new file mode 100644
index 0000000..b7fcb71
--- /dev/null
+++ b/Documentation/source/operations/documentation.rst
@@ -0,0 +1,51 @@
+Documentation
+=============
+
+Source Layout
+-------------
+
+Sphinx source files live in ``Documentation/source``. Use reStructuredText for
+all Sphinx pages.
+
+.. list-table::
+ :header-rows: 1
+ :widths: 26 50
+
+ * - Directory
+ - Purpose
+ * - ``architecture``
+ - System design, data model, auth, comments, feeds, and risk register.
+ * - ``frontend``
+ - Routes, UI conventions, components, and accessibility.
+ * - ``operations``
+ - Setup, environment, database, quality, and documentation workflow.
+ * - ``contributing``
+ - Commit, review, and code integrity practices.
+ * - ``reference``
+ - Stable route, command, glossary, and API references.
+
+Build Commands
+--------------
+
+Build HTML:
+
+.. code-block:: bash
+
+ make -C Documentation html
+
+Clean generated output:
+
+.. code-block:: bash
+
+ make -C Documentation clean
+
+Authoring Rules
+---------------
+
+* Write durable documentation in ``.rst`` files under ``Documentation/source``.
+* Keep raw notes in ``docs/`` only when they are not yet ready for the formal
+ documentation tree.
+* Prefer small pages with focused toctrees over long mixed-topic pages.
+* Use literal paths and commands with double backticks.
+* Add new pages to the nearest ``index.rst`` toctree.
+* Do not commit ``Documentation/build`` output.