docs-gen 用于库仓库的文档构建与推送,主要面向两类工作:为库撰写面向 AI 的文档,以及在库代码改动后同步受影响文档并推送到中心服务建索引。它只服务库仓库,检索内部库文档交由 docs-search 处理。
主要能力与使用方式:文档放在 agent-docs/ 目录,正文按服务端召回与切片机制撰写,强调指令精确、参数与默认值等事实明确、核心场景示例可运行。撰写时读取 references 下的服务端行为、文档规范、模板与范例等参考文件,按需读取,不一次全读。推送前需在仓库根目录确认 .pe.jsonc 中的 docs_server_url、docs_push_lib_name 以及 .env 中的 DOCS_TOKEN,并确保 .env 已加入 .gitignore。
推送命令在用户仓库根目录执行,脚本指向本技能内置脚本的绝对路径,使用 Node 内置 --env-file 加载 .env,例如:node --env-file=.env <本技能绝对路径>/scripts/push-docs.mjs;加 --verify 可在推送后逐篇按 title 验证可检索,加 --clear 可下架整库。推送为整库覆盖,任一篇校验失败整批不写库。
库代码改动后按范围判定影响面,仅公共导出可达的改动才影响文档,随后定位受影响篇目与章节并输出同步报告,有实质变更则进入推送。
限制:不编造 token、服务地址或库 slug;敏感配置只放 .env;不在目标仓库创建脚本副本;推送失败按报错处理,禁止盲目重试;不展开检索安装或查询步骤。