Commit 461b551
docs(nac-doc): dogfood improvements — project cheatsheet + actionable fallback
Two improvements from dogfood testing (simulating a zero-context new
contributor reading the docs):
1. .nac_doc/_overview.md now leads with a "项目速览 60 秒版" section:
- One-line project description
- ASCII architecture diagram (API → AgentRuntime → Services → Repo)
- The four dev process commands (dev-backend, dev-frontend, dev-mcp, dev-poller)
- Reminder about 铁律 #7 (双运行方式对齐)
Previously the overview jumped straight to the reading path, leaving a
new contributor without a project-level grounding until they followed
the reading path 2-3 layers deep.
2. CLAUDE.md "深度文档索引" fallback note rewritten from "按 .nac_doc/README.md
现场推断" (which doesn't actually work — README.md is project-agnostic
methodology) to a concrete 4-step fallback chain:
i. Read CLAUDE.md itself (four sections that cover most on-boarding)
ii. Read the corresponding mirror md (frontmatter points at source)
iii. Read the source file directly (docstrings are in English per 铁律 #1)
iv. On completion, fill in the mirror md per 铁律 #10
Plus explicit note that README.md is methodology, NOT project knowledge.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>1 parent 2e0ff96 commit 461b551
2 files changed
+32
-2
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
9 | 32 | | |
10 | 33 | | |
11 | 34 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
84 | 84 | | |
85 | 85 | | |
86 | 86 | | |
87 | | - | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
88 | 95 | | |
89 | 96 | | |
90 | 97 | | |
| |||
0 commit comments