docs: move repo tour to graph/ directory
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
chengma
co-authored by
Claude Fable 5
Claude Fable 5
parent
335bd44048
commit
6979a4ca5e
@@ -16,7 +16,7 @@
|
||||
| [`gitea.env.example`](gitea.env.example) | Gitea MCP 本机私有配置示例；复制后替换，真实文件不得入库 |
|
||||
| [`progress.md`](progress.md) | 可选：历史归档 / 项目级大事记；执行记录默认写各任务文件 |
|
||||
| [`docs/README.md`](docs/README.md) | 文档导航，总览所有项目文档 |
|
||||
| [`docs/repo-tour.md`](docs/repo-tour.md) | 新人导览：文档全景、工作流、任务生命周期流程图（描述样本库自身） |
|
||||
| [`graph/repo-tour.md`](graph/repo-tour.md) | 新人导览：文档全景、工作流、任务生命周期流程图（描述样本库自身） |
|
||||
| [`docs/00-ai-start-here.md`](docs/00-ai-start-here.md) | AI coding agent 的入口、阅读顺序、任务领取规则 |
|
||||
| [`docs/01-vision.md`](docs/01-vision.md) | 项目为什么做、为谁做、什么不做 |
|
||||
| [`docs/02-requirements.md`](docs/02-requirements.md) | 产品需求、功能范围、优先级与验收标准 |
|
||||
|
||||
+1
-1
@@ -16,7 +16,7 @@
|
||||
- [`../CLAUDE.md`](../CLAUDE.md)：Claude Code 的薄入口，具体规则以 `AGENTS.md` 为准。
|
||||
- [`../tasks.md`](../tasks.md)：当前样本库自身的维护任务列表，不是复制到新项目后的业务任务看板。
|
||||
- [`../progress.md`](../progress.md)：可选历史归档 / 项目级大事记；执行记录默认写各任务文件的 `## 执行记录`。
|
||||
- [仓库导览](repo-tour.md)：给新接手者的结构、工作流和任务生命周期流程图；描述样本库自身，复制模板到新项目时可不带。
|
||||
- [仓库导览](../graph/repo-tour.md)：给新接手者的结构、工作流和任务生命周期流程图；描述样本库自身，复制模板到新项目时可不带。
|
||||
- [AI 开发入口](00-ai-start-here.md)：agent 每次开始工作的入口、阅读顺序和任务领取规则。
|
||||
- [项目愿景](01-vision.md)：为什么做、为谁做、产品原则、非目标。
|
||||
- [需求](02-requirements.md)：要什么、功能范围、优先级、验收标准，不写技术实现。
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
| --- | --- | --- |
|
||||
| 任务列表 | 根目录 `tasks.md` | `docs/tasks/` 一任务一文件 |
|
||||
| 任务编号 | `H-xxx`（如 H-412） | `T-xxx`（如 T-001） |
|
||||
| 路线图 | `tasks.md` 的 Phase 0–6 | [`06-tasks.md`](06-tasks.md)（只读路线图） |
|
||||
| 路线图 | `tasks.md` 的 Phase 0–6 | [`06-tasks.md`](../docs/06-tasks.md)（只读路线图） |
|
||||
|
||||
## 二、文档全景图
|
||||
|
||||
@@ -112,11 +112,11 @@ flowchart TD
|
||||
H --> X["原型即视为过期<br/>不承担同步义务"]
|
||||
```
|
||||
|
||||
权威关系：行为的权威永远是[交互清单](08-interaction-checklist.md)，原型只是一次性输入物（约定见 [`design/README.md`](design/README.md)）；原型里有但需求没有的功能不能实现；禁止把原型代码直接复制进生产实现。
|
||||
权威关系：行为的权威永远是[交互清单](../docs/08-interaction-checklist.md)，原型只是一次性输入物（约定见 [`design/README.md`](../docs/design/README.md)）；原型里有但需求没有的功能不能实现；禁止把原型代码直接复制进生产实现。
|
||||
|
||||
## 六、暗语速查表
|
||||
|
||||
用户用短指令驱动工作，完整约定在 [`tasks/README.md`](tasks/README.md)：
|
||||
用户用短指令驱动工作，完整约定在 [`tasks/README.md`](../docs/tasks/README.md)：
|
||||
|
||||
| 触发词 | 含义 | 关键边界 |
|
||||
| --- | --- | --- |
|
||||
@@ -132,16 +132,16 @@ flowchart TD
|
||||
|
||||
## 七、第一天该做什么
|
||||
|
||||
1. 按顺序读：`AGENTS.md` → `README.md` → [`README.md`](README.md)（docs 导航）→ [`00-ai-start-here.md`](00-ai-start-here.md)。这四个读完，其余按需查。
|
||||
1. 按顺序读：`AGENTS.md` → `README.md` → [`README.md`](../docs/README.md)（docs 导航）→ [`00-ai-start-here.md`](../docs/00-ai-start-here.md)。这四个读完，其余按需查。
|
||||
2. 跑一次一致性校验：`python3 scripts/validate_agent_context.py`。
|
||||
3. `git log --oneline -20` 看最近提交——message 以任务编号结尾（如 `(H-413)`），顺着编号在 `tasks.md` 能找到每次改动的验收要点，这是本仓库的审计线索。
|
||||
4. 翻一眼[方法对照表](method-map.md)：失败模式 → 修复方法 → 对应工件，迷路时从这里找回入口。
|
||||
4. 翻一眼[方法对照表](../docs/method-map.md)：失败模式 → 修复方法 → 对应工件，迷路时从这里找回入口。
|
||||
5. 想练手，从 `tasks.md` 挑一个 `TODO` 的小任务，按第三节流程完整走一遍。
|
||||
|
||||
## 八、可选层：Gitea 多 Agent 协作
|
||||
|
||||
多 agent 并行开发时，用自建 Gitea 做协调——Issue/PR 管实时状态、`agent-context.json` 按任务类型路由必读文档、脚本做治理检查，见 [`gitea-mcp.md`](gitea-mcp.md) 和 [`gitea-collaboration.md`](gitea-collaboration.md)。**单人 + 单 agent 用不到它**；启用前先读安全基线（私有配置不入库、Token 不提交）。
|
||||
多 agent 并行开发时，用自建 Gitea 做协调——Issue/PR 管实时状态、`agent-context.json` 按任务类型路由必读文档、脚本做治理检查，见 [`gitea-mcp.md`](../docs/gitea-mcp.md) 和 [`gitea-collaboration.md`](../docs/gitea-collaboration.md)。**单人 + 单 agent 用不到它**；启用前先读安全基线（私有配置不入库、Token 不提交）。
|
||||
|
||||
---
|
||||
|
||||
迷路时的两个锚点：规则不确定 → 回 `AGENTS.md`；现状不确定 → 回 [`current-state.md`](current-state.md) 和 `git log`。聊天记录永远不是事实来源，仓库里的文件才是。
|
||||
迷路时的两个锚点：规则不确定 → 回 `AGENTS.md`；现状不确定 → 回 [`current-state.md`](../docs/current-state.md) 和 `git log`。聊天记录永远不是事实来源，仓库里的文件才是。
|
||||
Reference in New Issue
Block a user