mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-08-16 12:28:06 +00:00
docs: codify docs structure contract
This commit is contained in:
@@ -20,13 +20,16 @@ philosophy/
|
||||
|
||||
## 修改规则
|
||||
|
||||
- 继承 `docs/AGENTS.md` 的 README 结构契约:H1 后直接进入 `## 字多不看`,再按 `快速导航 -> 完整细粒度目录 -> 使用方式 -> 正文` 排列。
|
||||
- 新增模型时,优先补到 `README.md` 的对应章节。
|
||||
- 不再新增同级主题 `.md` 文件;如确需拆分,必须同步更新全仓链接和 `metadata/redirects.yml`。
|
||||
- 哲学内容必须落到工程判断或认知工具,不写成纯概念堆叠。
|
||||
- 重命名章节锚点时,必须同步更新全仓链接和 `metadata/redirects.yml`。
|
||||
- 不在 README 正文中写 `和其他目录的边界` 或 `维护规则`;维护者规则只写本文件。
|
||||
|
||||
## 质量要求
|
||||
|
||||
- 每个模型说明适用场景和使用方法。
|
||||
- 抽象概念应配工程例子或判断清单。
|
||||
- 保持术语稳定,避免同一模型出现多个标题口径。
|
||||
- 修改后必须运行 `make sync-doc-toc` 和 `make test`。
|
||||
|
||||
Reference in New Issue
Block a user