summaryrefslogtreecommitdiff
path: root/Documentation/source/reference/routes.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/reference/routes.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/reference/routes.rst')
-rw-r--r--Documentation/source/reference/routes.rst50
1 files changed, 50 insertions, 0 deletions
diff --git a/Documentation/source/reference/routes.rst b/Documentation/source/reference/routes.rst
new file mode 100644
index 0000000..93bcfd3
--- /dev/null
+++ b/Documentation/source/reference/routes.rst
@@ -0,0 +1,50 @@
+Route Reference
+===============
+
+Public Pages
+------------
+
+.. code-block:: text
+
+ /
+ /posts
+ /posts/[slug]
+ /tags
+ /tags/[tag]
+ /about
+ /login
+
+Admin and Payload
+-----------------
+
+.. code-block:: text
+
+ /admin
+ /api/[...slug]
+ /api/graphql
+ /api/graphql-playground
+
+Application APIs
+----------------
+
+.. code-block:: text
+
+ /api/auth/[...all]
+ /api/comments/[...comment]
+ /api/search
+
+Generated Assets
+----------------
+
+.. code-block:: text
+
+ /rss.xml
+ /banner.png
+ /og/[...slug]
+
+Route Ownership
+---------------
+
+Routes under ``src/app/(main)`` belong to the public application. Routes under
+``src/app/(payload)`` belong to Payload CMS integration and should be changed
+with care because they affect the admin and CMS API surface.