SuperAPI AI 工具集

docs-sync

写作与研究

查看项目

更新于 10-16 00:32

技能介绍

用途:docs-sync 是 WebUI 项目的文档同步工作流技能,适用于任何触及用户可见行为、API 或契约的改动,帮助把用户文档和 DESIGN.md 与架构变化保持对齐。

主要能力:按变更类型指明应更新的位置,例如 CLI 标志或命令对应 docs/guide/cli/index.md 与 docs/ai.md 的 Build and run 部分;模板语法或指令对应 docs/guide/concepts/directives/;组件编写模型对应 docs/guide/concepts/interactivity.md;路由行为对应 docs/guide/concepts/routing.md;状态管理对应 state-management/index.md;处理器 API、协议字段、插件系统、性能特性、公共 API、错误变体等也各有对应文档或 specs。DESIGN.md 仅在子系统职责与数据流、构建期与请求期归属、跨层设计不变量与兼容边界、复现系统所必需的技术选择发生变化时更新。

docs 规则:用户可见变更需在同一提交中更新 docs/,包括 CLI 用法或标志、模板语法或渲染输出、外部开发者依赖的集成行为、新增或移除功能、公共 API 边界。开发者文档只记录受支持的公共 API 与外部可观察契约,每项新增必须对应至少一个公共入口点,不得记录私有项、内部回调、中间表示、缓存算法、实现顺序或回归测试细节。protocol 内部实现不应放入通用用户文档。docs/ai.md 是单页 AI 参考,应与其他文档保持同步,并保持“编写优先”,深度参考材料保留在其规范页面并链接过去。ai/SKILL.md 只是稳定加载器,编写类变更应更新 docs/ai.md,而不是加载器或生成的 packages/webui/ai.md。

验证:文档改动后运行 cd docs && pnpm build,可捕获坏链接、VitePress 语法错误(代码块外未转义的 {{)和缺失页面。

样式规则:不使用 emdash(-),用连字符(-);围栏代码块外用 <code v-pre>{{expr}}</code> 转义 {{;使用正确的 CLI 标志名(查看 crates/webui-cli/src/commands/);验证 SSR 标记与 crates/webui-handler/src/plugin/webui.rs 源码一致。

限制:仅适用于 Microsoft WebUI 项目;具体版本、依赖与安装方式暂未提供。