mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-08-16 12:28:06 +00:00
docs: split docs readmes into topic files
This commit is contained in:
@@ -14,15 +14,21 @@
|
||||
|
||||
```text
|
||||
concepts/
|
||||
├── README.md # 线性总文档:问题求解、拼好码、系统构建、开发范式、语言层要素、递归自优化系统
|
||||
├── README.md # 索引入口:核心概念导航
|
||||
├── problem-solving.md
|
||||
├── glue-coding.md
|
||||
├── system-building.md
|
||||
├── development-paradigms.md
|
||||
├── language-layers.md
|
||||
├── recursive-self-optimizing-system.md
|
||||
└── AGENTS.md # 本目录操作规则
|
||||
```
|
||||
|
||||
## 修改规则
|
||||
|
||||
- 继承 `docs/AGENTS.md` 的 README 结构契约:H1 后直接进入 `## 字多不看`,再按 `快速导航 -> 完整细粒度目录 -> 使用方式 -> 正文` 排列。
|
||||
- 新增概念内容时,必须追加到 `README.md` 的对应章节。
|
||||
- 不再新增同级主题 `.md` 文件;如确需拆分,必须同步更新全仓链接和 `metadata/redirects.yml`。
|
||||
- 新增概念内容时,优先写入对应独立主题文档,并同步更新 `README.md` 索引。
|
||||
- 新增同级主题 `.md` 文件前,必须确认它是稳定概念,并同步更新全仓链接、`metadata/taxonomy.yml` 和必要的 `redirects.yml`。
|
||||
- 概念文档应优先使用稳定术语,避免同一概念多种叫法并存。
|
||||
- 不把一次性操作步骤放入本目录;操作型内容应放入 `docs/getting-started/` 或 `docs/references/`。
|
||||
- 不在 README 正文中写 `和其他目录的边界` 或 `维护规则`;维护者规则只写本文件。
|
||||
|
||||
Reference in New Issue
Block a user