docs: codify docs structure contract

This commit is contained in:
tukuaiai
2026-05-05 02:11:38 +08:00
parent e6012e88c6
commit 370f0432ac
8 changed files with 53 additions and 3 deletions
+3
View File
@@ -22,13 +22,16 @@ research/
## 修改规则
- 继承 `docs/AGENTS.md` 的 README 结构契约:H1 后直接进入 `## 字多不看`,再按 `快速导航 -> 完整细粒度目录 -> 使用方式 -> 正文` 排列。
- 每篇研究笔记聚焦一个技术、repo、范式或工具,并追加到 `README.md`
- 不再新增同级主题 `.md` 文件;如确需拆分,必须同步更新全仓链接和 `metadata/redirects.yml`
- 研究内容稳定后,放入 `docs/concepts/``docs/references/``docs/philosophy/` 的对应章节。
- 外部项目、模型、工具、版本和事实状态可能变化,涉及最新信息时必须核验来源。
- 不在 README 正文中写 `和其他目录的边界``维护规则`;维护者规则只写本文件。
## 质量要求
- 不写新闻转述,要给出判断、边界、采用建议和后续观察点。
- 对不确定信息标注“待验证”或 TODO。
- 引入外部事实时优先引用官方文档、原始仓库、论文或可信一手来源。
- 修改后必须运行 `make sync-doc-toc``make test`