SuperAPI AI 工具集

setup-codebase-docs

智能体与模型

查看项目

更新于 10-15 21:11

技能介绍

用途:为任意代码库一次性搭建两个私有 Blume 2.x 文档应用。internal-human-docs 面向负责人或创始人,用散文和图表说明产品如何运作,包括流程、数字、资金、风险与决策;internal-agent-docs 面向编码智能体,记录精确的文件、符号、契约、不变量、命令、变更配方、运行手册与参考记录。

主要能力:从代码手写每一页内容,而非套模板或搬运旧文档;以代码为准核对路径、名称、数字、状态与限制;覆盖每个流程、集成、数据存储、任务、计算、限制、设置与失败路径;把旧文档、运行手册和根目录笔记迁移到新站点,并改写仓库内旧路径引用;在根 AGENTS.md 中加入规则,要求智能体每次变更都更新两个站点。

使用方式:先检查仓库结构与规则文件,确认 Node >= 22.19 与最新 Blume 2.x;选择放置位置(Turborepo 用 apps/internal-human-docs 与 apps/internal-agent-docs);搭建两个应用并验证可构建;映射代码库、规划章节、手写页面;迁移旧文档;接入 AGENTS.md;最后运行 blume validate --strict、blume build、bun <skill-dir>/scripts/doc-paths.ts check 及仓库的 format、lint、typecheck、tests 等检查并汇报。

限制:不得写入密钥、令牌、客户或会话数据,只可提及环境变量与密钥存储名称;提交、推送、部署、创建托管项目、添加生产依赖或删除无新归属的文档前须先征得同意;仅在用户或仓库规则允许时使用并行助手;Blume 仅作为文档应用的开发依赖。具体托管步骤、端口与命令需按仓库实际情况填写,资料未提供固定值。