仓库根目录只保留 GitHub 社区约定与 Agent 治理入口;产品与架构长文集中在本目录。
五层文档治理见document-governance.md。
| 你是谁 | 先读 |
|---|---|
| 了解产品(官网) | index.html(GitHub Pages · 中英双语) |
| 新用户 / 第一次安装 | GETTING_STARTED.md(5 分钟上手 · 中英双语) |
| Homebrew / winget 渠道 | PACKAGE_MANAGERS.md |
| 维护者发版 / AI 代劳 | RELEASE_MAINTAINER.md |
| 评估产品能力 | PRODUCT_INTRO.md |
| Design 模式(产品/业务) | DESIGN_PRODUCT_INTRO.md · DESIGN_WORKSPACE_GUIDE.md |
| 安装 DMG / Windows | INSTALL.md |
| macOS 应用内更新 | UPDATES.md |
| 从源码开发 | BUILD_FROM_SOURCE.md |
| 贡献代码 | 根目录 CONTRIBUTING.md(PR base:dev)+ CLAUDE.md |
| 第三方 MCP 接入 | mcp-servers/(社区/第三方集成指南) |
| 前端 UI 开发 | UI_UX_GUIDELINES.md |
| 架构与数据流 | ARCHITECTURE.md |
| 文档 | 用途 |
|---|---|
PRODUCT_INTRO.md |
定位、痛点、功能清单、运行机制 |
DESIGN_PRODUCT_INTRO.md |
Design 模式 WHAT/WHY(产品经理 / 业务) |
DESIGN_WORKSPACE_GUIDE.md |
Design 模式功能与业务逻辑分析 |
ARCHITECTURE.md |
系统架构、LangGraph 工作流、WebSocket、ADR |
PROJECT_SCOPE.md |
Goals / Non-Goals |
EXTENSIBILITY.md |
官方扩展点与禁止替换区域 |
STABILITY.md |
API / Schema 稳定性承诺 |
PERFORMANCE.md |
性能基线与 benchmark 说明 |
| 文档 | 用途 |
|---|---|
GETTING_STARTED.md |
新手入门 — 安装后首聊、向导步骤、常见配置(中英双语) |
INSTALL.md |
DMG / Windows 安装、Gatekeeper、应用内更新、首次使用、卸载 |
APPLE_NOTARIZATION.md |
Apple 签名/公证步骤;无账号则阻塞(D31 / FM-21) |
UPDATES.md |
macOS 应用内自动更新(OSR-20)· 维护者 go-live 清单 |
BUILD_FROM_SOURCE.md |
克隆、依赖、pnpm tauri:dev、本地打包 |
DATA_AND_PRIVACY.md |
本地数据目录、第三方 LLM、用户权利 |
| 文档 | 用途 |
|---|---|
OPEN_SOURCE_RELEASE.md |
OSR-xx 开源排期与验收 |
GOVERNANCE.md |
维护者决策与合并政策 |
document-governance.md |
五层架构、权威真相(SoT)、文档生命周期与归档 |
根目录 SECURITY.md |
漏洞私密报告(GitHub 约定放根目录) |
EXTERNAL_AUDIT.md |
外包审计委托;报告索引 security-audit/(FM-22) |
根目录 CODE_OF_CONDUCT.md |
社区行为准则 |
根目录 CHANGELOG.md |
版本变更记录(Release 硬门禁) |
releases/ |
各版本产品快照(历史;当前见 PRODUCT_INTRO.md) |
| 文档 | 用途 |
|---|---|
UI_UX_GUIDELINES.md |
React + Tailwind 组件与视觉规范(权威) |
FRONTEND_MODULES_ACCEPTANCE.md |
FM-01…22 桌面点验剧本(入口、步骤、期望;状态只在 ROADMAP) |
PLATFORM_MAINTENANCE.md |
macOS / Windows 平台 UI 文件边界 |
specs/core/design.md |
视觉设计历史快照 → 以上规范 |
根目录 PRODUCT.md |
战略设计寄存器(impeccable:用户、品牌、原则) |
| 文档 | 用途 |
|---|---|
memory/PROGRESS.md |
跨会话进度接力 |
memory/FILEMAP.md |
改代码去哪个文件 |
memory/DECISIONS.md |
架构决策与开放问题 |
specs/core/tasks.md |
M0–M4 开发任务清单 |
specs/core/hybrid-runtime-plan.md |
D25 Hybrid Runtime(HRT-xx) |
specs/core/d34-terminal-orchestra-plan.md |
D34 Terminal Orchestra Task |
specs/core/frontend-modules-plan.md |
前端可点验模块 FM-01…22(D56) |
| 文档 | 用途 |
|---|---|
research/ |
探索性设计笔记 — Research Notice,非真相源 |
archive/ |
历史叙事(规划、handover)— Archive Notice |
archive/AI_STUDIO_HANDOVER.md |
原型期前端交接(过时);根目录 AI_STUDIO_HANDOVER.md 仅为跳转 stub |
agents/ |
Issue tracker / triage 技能说明 |