summaryrefslogtreecommitdiff
path: root/Documentation/source/zh_CN/introduction.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/zh_CN/introduction.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/zh_CN/introduction.rst')
-rw-r--r--Documentation/source/zh_CN/introduction.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/Documentation/source/zh_CN/introduction.rst b/Documentation/source/zh_CN/introduction.rst
new file mode 100644
index 0000000..1746b00
--- /dev/null
+++ b/Documentation/source/zh_CN/introduction.rst
@@ -0,0 +1,46 @@
+项目介绍
+========
+
+Next Blog 是一个以阅读体验为核心的全栈博客平台。它使用 Next.js App Router 构建公开站点,使用 Payload CMS 管理内容,并通过 PostgreSQL、Drizzle ORM、better-auth 和 Fuma Comments 提供认证、评论与应用数据能力。
+
+产品范围
+--------
+
+当前项目聚焦在以下能力:
+
+* 通过 Payload CMS 创建、编辑、发布文章;
+* 渲染首页、文章列表、文章详情、标签页和个人页面;
+* 通过 Google 与 GitHub OAuth 登录;
+* 为登录用户提供评论功能;
+* 输出搜索索引、RSS、站点地图、JSON-LD 和 Open Graph 图片;
+* 提供 Newsletter 表单与 React Email 模板。
+
+这个项目不是通用社区 CMS,而是一个受控的个人发布系统:公开侧重阅读,后台侧重内容管理。
+
+核心角色
+--------
+
+.. list-table::
+ :header-rows: 1
+ :widths: 20 34 36
+
+ * - 角色
+ - 目标
+ - 主要入口
+ * - 访客
+ - 浏览和阅读内容。
+ - ``/``、``/posts``、``/posts/[slug]``、``/tags``
+ * - 回访读者
+ - 通过标签筛选内容并订阅读者入口。
+ - ``/tags/[tag]``、``/rss.xml``
+ * - 登录用户
+ - 发表评论和使用账号相关操作。
+ - ``/login``、``/posts/[slug]``
+ * - 内容管理员
+ - 维护、排期和发布内容。
+ - ``/admin``
+
+文档定位
+--------
+
+``Documentation/source`` 是本项目正式的 Sphinx 文档源目录。``docs/`` 中的 Markdown 文件可以继续作为调研或草稿材料,但稳定的工程文档应整理为 reStructuredText 后进入本目录。