mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-08-13 10:58:05 +00:00
docs: split docs readmes into topic files
This commit is contained in:
@@ -15,16 +15,25 @@
|
||||
|
||||
```text
|
||||
references/
|
||||
├── README.md # 线性总文档:工程实践、技术栈
|
||||
├── README.md # 索引入口:参考资料导航
|
||||
├── project-architecture-template.md
|
||||
├── python-project-skeleton.md
|
||||
├── enterprise-architecture-template.md
|
||||
├── dataset-first-data-service.md
|
||||
├── code-organization.md
|
||||
├── development-experience.md
|
||||
├── quality-gates-and-pitfalls.md
|
||||
├── low-level-program-logic.md
|
||||
├── technology-stack.md
|
||||
├── AGENTS.md # 本目录操作规则
|
||||
```
|
||||
|
||||
## 修改规则
|
||||
|
||||
- 继承 `docs/AGENTS.md` 的 README 结构契约:H1 后直接进入 `## 字多不看`,再按 `快速导航 -> 完整细粒度目录 -> 使用方式 -> 正文` 排列。
|
||||
- 新增参考资料时,直接追加到 `README.md` 的对应章节。
|
||||
- 检查清单、模板、质量门禁和经验类内容优先合并进 `工程实践` 章节。
|
||||
- 技术选型、技术栈组合和学习路径优先合并进 `技术栈` 章节。
|
||||
- 新增参考资料时,优先写入对应独立主题文档,并同步更新 `README.md` 索引。
|
||||
- 检查清单、模板、质量门禁和经验类内容优先进入对应独立文档,避免重新塞回 README。
|
||||
- 技术选型、技术栈组合和学习路径优先维护在 `technology-stack.md`。
|
||||
- 不在本目录写一次性研究笔记;新技术判断应先放入 `docs/research/`。
|
||||
- 不在 README 正文中写 `和其他目录的边界` 或 `维护规则`;维护者规则只写本文件。
|
||||
|
||||
|
||||
Reference in New Issue
Block a user