user-manual-sync

# User Manual (Wiki) Sync ## Overview a2wave 的「使用手册」是 Web 内置的 `/wiki` 页面,面向**终端用户**讲解平台功能怎么用。 内容是一组 Markdown,由 Vite 在构建时打包进前端 —— **没有后端 API,不读 `docs/`,不进运行镜像之外的任何源**。 | 关注点 | 位置 | |--------|------| | 章节正文(中文) | `apps/web/src/content/manual/zh/NN-slug.md` | | 章节正文(英文,可选) | `apps/web/src/content/manual/en/NN-slug.md` | | 加载/排序逻辑 | `apps/web/src/lib/manual.ts` | | 页面组件(左目录+右正文) | `apps/web/src/pages/wiki.tsx` | | 路由 `/wiki` `/wiki/:slug` | `apps/web/src/app.tsx` | | 侧栏入口 + 文案 | `apps/web/src/components/layout.tsx`、`apps/web/src/locales/{zh,en}.json` | | E2E | `e2e/tests/pages/wiki.spec.ts`、`e2e/utils/test-constants.ts` | > 区分:这里说的是「面向用户的产品使用手册」,不是开发者文档(`docs/`)、也不是平台 Skill 功能。 **当前结构(v2):** 共 15 章,落地页(`/wiki` 首屏)是 `01-overview.md`(slug `overview`,标题「概览与导航」),含「按场景 / 按角色速查」两张表;其后是 `getting-started`、`concepts`,各功能章,末尾 `faq`、`glossary`。读者定位为「终端用户 + 集成开发者」,触发方式等章含真实调用示例。 ## When to Use 新功能开发完成 / 改动触及**用户可感知行为**时,必须走一遍本 skill 判断手册是否要更新: - 新增页面、路由、导航项 - 新增或改变某项能力的用法(Agent / Provider / MCP / Skill / 代码源 / 知识库 / 运行记录) - 新增或调整触发方式、外部集成、鉴权方式 - 改变面向用户的操作流程、术语、限制(铁律) 仅内部重构、不影响用户用法时,可不更新,但要在 PR/commit 里说明「无用户可见变更,手册无需更新」。 ## Core Workflow ``` 判断影响范围 → 选择动作(改/增章节) → 遵守命名与交叉链接约定 → 校验 → 同步 E2E ``` ### 1. 判断该改哪一章 对照现有章节(`apps/web/src/content/manual/zh/` 下 `01..NN`)。功能属于已有主题就**改对应文件**;是全新主题就**新增一章**。 ### 2A. 改现有章节(最常见) 直接编辑对应 `zh/NN-slug.md`,用面向用户的口吻补充「这是什么 / 怎么用 / 注意什么」。**不要**写实现细节、文件路径、内部 API。 ### 2B. 新增章节 1. 在 `apps/web/src/content/manual/zh/` 新建 `NN-slug.md`: - `NN`(数字前缀)决定...