Appearance
文档盘点
这页是本次文档整理的结果说明,重点回答 3 个问题:
- 哪些文档已经可以直接进入独立文档站
- 哪些文档有价值,但需要改写
- 哪些文档更适合保留在内部,不建议直接公开
已经迁移进文档站
| 当前文档页 | 原始来源 | 处理方式 |
|---|---|---|
| 快速开始 | website/content/docs/zh/quick-start/get-started.md | 可直接复用,轻度整理 |
| Introduction | reference/vue-js-docs 的结构方式 + 当前客户端真实流程 | 按 Workova 重写,不照搬原文表达 |
| Workspace 总览 | website/content/docs/zh/workspace/overview.md | 可直接复用,轻度整理 |
| 工作区与导航 | desktop/apps/gui/src/app/router.tsx 与 GUI 实际导航 | 按真实入口重写 |
| AI 助理 | desktop/apps/gui/src/features/agent/* | 按真实页面和会话流程重写 |
| 工作流 | desktop/apps/gui/src/legacy/workflows/* | 结合现有实现重写 |
| 自动化 | desktop/apps/gui/src/features/automation/* | 按真实触发器与运行记录流程重写 |
| 技能 | desktop/apps/gui/src/features/skills/* | 按真实页面能力重写 |
| 工具与 MCP | desktop/apps/gui/src/features/mcp/*、设置页命令行工具卡片 | 按真实页面能力重写 |
| 建立第一条工作流 | website/content/docs/zh/workflow/build-first-flow.md | 可直接复用,轻度整理 |
| 用 Agent 组织协作 | website/content/docs/zh/agent/orchestrate-with-agents.md | 可直接复用,轻度整理 |
| CLI 使用指南 | docs/desktop/CLI命令规范.md + desktop/apps/cli 实际帮助输出 | 已按当前实现修正语法和执行模型 |
| CLI 总览 | desktop/apps/cli 当前实现 | 作为参考页新增 |
| CLI 命令分组 | desktop/apps/cli/src/index.ts 与 contracts:list | 作为参考页新增 |
| CLI 参数与环境变量 | desktop/apps/cli/src/lib/* 与 docs/desktop/CLI命令规范.md | 作为参考页新增 |
| 在市场中发布资产 | website/content/docs/zh/market/publish-assets.md | 可直接复用,当前更偏产品说明 |
| 连接 MCP 与上下文能力 | website/content/docs/zh/mcp/connect-context.md | 可直接复用,轻度整理 |
| 项目总览 | README.md | 抽出开发者最常用信息 |
| 开发环境快速开始 | README.md | 抽出统一安装、启动与验证路径 |
| Desktop 工作区概览 | desktop/README.md | 可直接复用,适合新同学先看 |
| Backend 概览 | backend/README.md | 可直接复用,适合作为后端入口 |
| Admin Web 概览 | admin-web/README.md | 可直接复用,适合作为后台入口 |
| 插件开发快速上手 | docs/PLUGIN_DEVELOPER_QUICKSTART.md | 可直接复用,改成站内链接 |
| 插件开发总览 | docs/PLUGIN_DEVELOPMENT_GUIDE.md | 保留关键结构,并标注历史路径 |
| 官方插件模板 | docs/plugin-examples/README.md 等 | 合并模板说明 |
| 插件开发入口 | docs/PLUGIN_DEVELOPMENT_GUIDE.md + 当前文档站结构 | 作为开发参考入口新增 |
| plugin.manifest 参数说明 | 当前插件 schema 与插件文档 | 作为字段参考页新增 |
| 后端快速开始 | docs/backend/快速开始指南.md | 可直接复用,删减冗余 |
| 桌面端架构基座 | desktop/docs/ARCHITECTURE.md | 可直接复用,适合开发者阅读 |
| Agent Runtime 当前架构 | docs/AGENT_RUNTIME_FINAL_ARCHITECTURE.md | 当前边界最明确,先整体迁入 |
有价值,但需要明显改写
| 原始文件 | 当前问题 | 建议去向 |
|---|---|---|
docs/产品需求文档-完整版.md | 仍描述 Python sidecar,和当前桌面端真源架构不一致 | 拆成“产品定位”与“路线图”两篇新文档 |
docs/desktop/DEVELOPMENT.md | 标题虽然叫“开发指南”,但内容仍指向 archive/desktop-legacy | 重写成当前 desktop/ 工作区开发指南,再放进开发者板块 |
docs/desktop/桌面端技术架构文档.md | 多处路径和约束已经过期 | 重写成“当前桌面端技术架构” |
docs/desktop/MCP服务架构文档.md | 仍引用旧目录与旧页面结构 | 改写成当前 runtime 和 GUI 的 MCP 文档 |
docs/backend/项目概览.md | “已完成内容”是阶段性快照,容易过期 | 改成长期有效的模块说明 |
docs/QUOTA_AND_USAGE_GUIDE.md | 偏接口说明,没有用户视角说明 | 拆成“用户配额说明”和“开发接口说明” |
docs/设计规范.md | 更像品牌和视觉规范草稿 | 改成设计系统文档或品牌规范 |
docs/admin-web/技术架构设计.md | 适合开发者,但结构偏旧 | 收敛成管理后台开发指南 |
docs/backend/管理后台-技术架构设计.md | 适合内部开发者,不适合直接公开 | 拆成接口架构说明与管理能力说明 |
不建议直接公开到文档站
| 原始文件 | 原因 |
|---|---|
docs/adr/*.md | ADR 属于内部架构决策记录,不适合直接给普通用户或普通开发者入口 |
docs/backend/CHANGELOG.md | 阶段性记录价值有限,且容易过期 |
docs/desktop/MIGRATION_STATUS.md | 迁移审计文档偏内部过程管理 |
docs/desktop/TEST_SUMMARY.md | 测试摘要更适合内部质量记录 |
docs/backend/SECURITY_TESTING.md | 安全测试细节不适合作为公开入口文档 |
docs/backend/scripts/ADMIN_SETUP_GUIDE.md | 包含后台默认账户初始化语义,适合内部运维使用 |
当前结论
这次文档整理不是“把所有 Markdown 搬过去”,而是先把真正能给人看的内容稳定下来。
这样做的好处是:
- 用户不会看到过期架构
- 开发者不会被旧目录误导
- 后续补文档时,目标更清楚