跳转至

文档站规格

这一栏只解释 docs-site/ 自己怎么组织,不解释训练逻辑细节。

这里有哪些规格文件

  • MkDocs PRD:规定文档站要有什么结构、双语要求、导航要求和写作边界。
  • GitHub Actions PRD:规定文档站如何构建和发布到 GitHub Pages。
  • Markdown 树:列出哪些文件是直写文件,哪些是 symlink,并明确源文件和终点文件。

为什么需要这几份文件

文档站本身也是一个需要长期维护的小工程。没有自己的规格文件,后面最容易发生两件事:

  1. 新文档加进来了,但没人知道该直写还是该 symlink。
  2. 导航和目录开始漂移,最后中英文结构失配。

在本项目里怎么用

如果你准备继续扩展文档站,先看:

  1. Markdown 树,确认目标文件应该放哪里。
  2. MkDocs PRD,确认新增内容会不会破坏 DRY、双语结构和导航约束。
  3. GitHub Actions PRD,确认变更是否影响部署边界。