SuperAPI AI 工具集

update-docs

通用与其它

查看项目

更新于 10-16 02:32

技能介绍

用途:该技能用于更新 ryOS 的手写文档,使其与代码库当前实现保持一致,适用于更新文档、同步文档或文档内容疑似过时的情况。

主要能力:按文档章节并行启动子代理,每节读取现有文档、分析相关代码、更新过时或缺失信息,并保留原有结构。章节文件位于 docs/,覆盖 Overview、Apps Index、Framework、AI System、File System、Audio System、UI Components、API Reference、Legal 等。使用前先运行 ls docs/*.md 确认当前存在的章节列表。

使用方式:按章节启动并行 Task 完成更新;变更日志 docs/9-changelog.md 需人工维护,不得重新生成,可用 git log 查询上次整理后的提交,再向当月 details 块追加条目并更新计数,重要功能可在 changelog-feature-grid 顶部添加 featured 卡片,每月最多 5 张。截图需为 1280×720 WebP,命名 YYYY-MM-NN-slug-16x9.webp,放入 public/docs-assets/changelog/。随后运行 bun run generate:docs 生成 HTML,运行 bun test tests/unit/i18n/test-changelog-docs-sync.test.ts tests/unit/i18n/test-generate-docs-path-links.test.ts 校验同步,并用 git diff docs/ public/docs/ tests/ 检查改动。

限制:应用页面 2.1–2.x 由 generate-app-docs.ts 自动生成,不要手动编辑;不要对已人工整理的变更日志使用 --force 或 generate:docs:full;保留标题、mermaid 图表与格式,仅更新明确过时的信息;自托管页面提交可能被密钥扫描拦截,需撤回。其他收费、价格与平台信息暂未提供。