Skip to content

Commit 461b551

Browse files
BinLiang2021claude
andcommitted
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

File tree

2 files changed

+32
-2
lines changed

2 files changed

+32
-2
lines changed

.nac_doc/_overview.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,30 @@ last_verified: 2026-04-09
55

66
# NexusAgent · `.nac_doc/` 顶层入口
77

8-
欢迎。这是 NexusAgent 项目的三级文档系统入口。如果你是第一次来,按下面的顺序读:
8+
欢迎。这是 NexusAgent 项目的三级文档系统入口。
9+
10+
## 项目速览(60 秒版)
11+
12+
**NexusAgent** 是一个拥有长期记忆(Narrative)、Module 可热插拔的 Agent 系统。核心是算法 + Agent 的开发;前后端 + 桌面端(Tauri)同等重要。
13+
14+
**架构一眼**(完整版见 `CLAUDE.md` 的「架构分层」章节):
15+
16+
```
17+
API (FastAPI) → AgentRuntime (7 步流水线) → Services (Narrative, Module)
18+
19+
Background (ModulePoller) ←→ Repository → DB (MySQL/SQLite)
20+
```
21+
22+
**怎么跑起来**(4 个进程,各一个终端;完整列表 `make help`):
23+
24+
```bash
25+
make dev-backend # FastAPI 后端,port 8000
26+
make dev-frontend # Vite 前端
27+
make dev-mcp # MCP servers(Module 的 tool 服务)
28+
make dev-poller # ModulePoller 后台服务
29+
```
30+
31+
**双运行方式对齐**(铁律 #7):本地开发走 `bash run.sh``make dev-*`;桌面端走 Tauri dmg。改动任何一个必须检查另一个。
932

1033
## 新人推荐阅读路径
1134

CLAUDE.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,14 @@
8484
- `.nac_doc/project/playbooks/work_with_worktree.md` — worktree 流程
8585
**何时读**:开始多人并行任务、或按 superpowers 流程启动 plan
8686

87-
> 注:以上 references / playbooks 的实际内容可能还未写就(Phase 2 内容创作工作)。未写时 Read 会返回 file-not-found,这种情况下按 `.nac_doc/README.md` 的方法论现场推断。
87+
> **未写就时的 fallback**(Phase 2 内容创作工作延后):Read 返回 file-not-found 时,按以下顺序回退——
88+
>
89+
> 1. **先读 CLAUDE.md 本文**`项目介绍``架构分层``新建 Module 步骤`(简表版)、`编码规范` 这四节合起来覆盖了绝大部分 on-board 信息
90+
> 2. **再读对应的 mirror md**`.nac_doc/mirror/<path>.md` —— 即使是 stub,frontmatter 的 `code_file` 也会告诉你去读哪个源码文件
91+
> 3. **最后读源码**`code_file` 指向的 `.py/.tsx/.ts/.rs`,配合 docstring 和文件头注释(铁律 #1 保证都是英文)
92+
> 4. **完工时回填 mirror md**:按铁律 #10,在同一 commit 内把你理解的 intent 写进对应 mirror md,把 frontmatter 的 `stub: true` 改成 `false`,刷新 `last_verified`
93+
>
94+
> `.nac_doc/README.md`**方法论**,教你 HOW 写 md,不是项目知识;它**无法**替代项目特定信息。
8895
8996
---
9097

0 commit comments

Comments
 (0)