最后更新:2026-07-18
| 角色 | 先读 | 然后 |
|---|---|---|
| 新开发者 | developer-quickstart.md | architecture.md |
| 评审/产品 | architecture.md | decisions.md → governance/threat-model.md |
| 贡献者 | ../CONTRIBUTING.md | developer-quickstart.md · ../AGENTS.md |
| 功能设计 | architecture.md | decisions.md |
| 历史追溯 | history.md · archives/ | TokenDance docs 外部归档 |
端口速记:Desktop/Tauri 5173,Web 5174,Mobile RN Expo 5177,Hub 8080,Edge 3210。
docs/
├── README.md ← 导航索引(你在这里)
├── developer-quickstart.md ← 新人入门
├── architecture.md ← 架构概览(→ architecture/ 模块详情)
├── architecture/ ← 模块化架构文档
├── plan/ ← 现役 SPEC(历史 plan 见 archives/plan/)
├── analysis/ ← 当前 owner 分析/Accepted decision 输入;历史见 archives/
├── archives/ ← 已关闭程序快照(cleanup-baseline 等)与历史文档归档
├── decisions.md ← 当前架构决策摘要
├── governance/ ← 治理:执行映射、安全风险、威胁模型
├── history.md ← 历史归档索引(外部 TokenDance docs)
├── images/ ← 截图与图片资源
└── reference/ ← 轻量技术参考
| 需要 | 去看 |
|---|---|
| API 索引 | api-reference.md |
| 模块架构 | architecture/README.md |
| 当前架构决策摘要 | decisions.md |
| 旧架构决策正文和背景 | history.md |
| 现役 SPEC | plan/(历史 plan 见 archives/plan/) |
| 当前仓库布局裁决 | analysis/root-layout.md;历史分析见 archives/ 与 history.md |
| 项目规则和文档规则 | ../AGENTS.md |
| WebSocket 事件合同 | ../api/events.md |
| SDK Agent 策略 | reference/sdk-agent-strategy.md |
| 分支和 worktree 规则 | ../AGENTS.md |
| 安全风险 | governance/security-risk-register.md |
| 威胁模型 | governance/threat-model.md |
| 后端性能/泄漏证据 | reference/backend-performance-gates.md |
| 发布/截图历史清单 | history.md |