chore: references - generate readme from sources

This commit is contained in:
tukuaiai
2026-05-04 05:01:12 +08:00
parent 2eafa33fee
commit 95c591bdd2
17 changed files with 5714 additions and 14 deletions
+6 -3
View File
@@ -15,13 +15,15 @@
```text
references/
├── README.md # 线性总文档:工程实践、技术栈
── AGENTS.md # 本目录操作规则
├── README.md # 生成后的线性总文档:工程实践、技术栈
── AGENTS.md # 本目录操作规则
└── sources/ # README.md 的有序源片段
```
## 修改规则
- 新增参考资料时,必须追加到 `README.md` 的对应章节
- 新增参考资料时,必须追加到 `sources/` 的对应源片段,再运行 `make sync-reference-readme`
- 不直接编辑 `README.md` 主体内容;它由 `scripts/build-reference-readme.py` 从源片段生成。
- 检查清单、模板、质量门禁和经验类内容优先合并进 `工程实践` 章节。
- 技术选型、技术栈组合和学习路径优先合并进 `技术栈` 章节。
- 不在本目录写一次性研究笔记;新技术判断应先放入 `docs/research/`
@@ -31,3 +33,4 @@ references/
- 参考文档必须可执行、可检查、可复用。
- 门禁类内容尽量转成测试、CI、脚本、schema、类型或检查清单。
- 不确定项必须标注 TODO,不能编造成熟结论。
- 提交前必须运行 `make test`,确保生成状态、锚点、链接和目录结构一致。