SuperAPI AI 工具集

clean-docs

通用与其它

查看项目

更新于 10-16 06:43

技能介绍

用途:扫描 www/content/docs/ 下每个 .mdx 文档,按 @docs/solutions/style.md 样式指南进行清理。使用方式是配合 planning-with-files 技能(reset 模式)执行该任务。

主要能力与规则:保留提示框(<Callout>,尤其在章节末尾)、文档与章节开头的引导/过渡文字、对话式语气与渐进式铺垫、庆祝式结尾,以及全部技术内容(信息无损)。移除营销性填充词(如 battle-tested、secret sauce、you can copy into your project)、同一文档中重复陈述的信息(重复代码块、重述上方表格的句子)、同一文件出现 2-3 次的相同代码块(保留首次出现,后续改为交叉引用如 See section above),以及对使用无帮助的内部实现说明。修正线性顺序,使概念渐进构建而非来回跳跃。

流程:用 planning-with-files 创建 task_plan.md,把全部 54 个文档列为检查项;将文档分批交给并行代理(每个代理 5-6 个文件)扫描。第一遍保守处理:grep 已知填充模式,修正明显营销语言。第二遍深入:逐文件阅读,查找重复代码块、DRY 违规与顺序问题。将每个文档标记为无需修改或已更新(说明改动内容)。全部编辑后运行 bun lint:fix。

限制:仅适用于 .mdx 文档及指定目录结构,依赖 @docs/solutions/style.md 样式指南与 planning-with-files 技能;其他环境或文件类型的适用性暂未提供。