mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-08-13 19:08:05 +00:00
docs: split docs readmes into topic files
This commit is contained in:
@@ -8,7 +8,8 @@
|
||||
|
||||
```text
|
||||
workflow/
|
||||
├── README.md # 线性总文档:开发流程集合
|
||||
├── README.md # 索引入口:开发流程导航
|
||||
├── development-process.md
|
||||
└── AGENTS.md # 本目录操作规则
|
||||
```
|
||||
|
||||
@@ -16,7 +17,7 @@ workflow/
|
||||
|
||||
- 继承 `docs/AGENTS.md` 的 README 结构契约:H1 后直接进入 `## 字多不看`,再按 `快速导航 -> 完整细粒度目录 -> 使用方式 -> 正文` 排列。
|
||||
- 本目录只放流程类文档,不放一次性任务记录、日志、源码快照或私密配置。
|
||||
- 新增流程时优先追加到 `README.md`,不新增同级主题 `.md` 文件。
|
||||
- 新增流程时写入独立流程文档,并同步更新 `README.md` 索引。
|
||||
- 新增流程必须能被执行、检查和复用,避免只写抽象口号。
|
||||
- 涉及命令、路径、配置、CI、Git 操作时,必须与仓库当前事实一致。
|
||||
- 不在本目录保存密钥、Token、本地账号、真实私有项目配置或一次性日志。
|
||||
|
||||
Reference in New Issue
Block a user