From dbb5e791f0c228369605d126dd590962ebe1eddc Mon Sep 17 00:00:00 2001
From: Bertrand Yuan <me@bertyuan.com>
Date: Mon, 27 Apr 2026 20:52:54 +0800
Subject: 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>
---
 Documentation/source/operations/documentation.rst | 51 +++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 Documentation/source/operations/documentation.rst

(limited to 'Documentation/source/operations/documentation.rst')

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.
-- 
cgit v1.2.3