用途:ai-docs 用于指导和规范 AI 文档的编辑与生成流程,重点覆盖 ai-docs/src 下的源码修改以及 LLMS.md 的重新生成。
主要能力与流程:
- 阅读 ai-docs/README.md,该文件是文档规范的权威来源,涵盖源码结构、写作风格、示例、生成方式和变更集(changeset)策略。
- 查看相邻的源码示例以及当前相关的 LLMS.md,以了解既有约定与上下文。
- 在 ai-docs/src 目录下编辑源码,然后运行 pnpm ai-docgen 重新生成文档。
- 检查生成结果,重点关注排序是否正确、是否有内容缺失以及是否出现无关改动。
- 运行适用的根级校验。
完成标准:源码与生成输出保持一致;每处生成差异都能得到解释;当示例或测试数据发生变化时,TypeScript 检查通过;适用的检查通过,或已明确报告为不可运行。
适用场景:适用于需要维护项目 AI 文档、保持文档源码与生成产物同步的开发者,尤其是使用 pnpm 与 ai-docgen 工具链的仓库。
限制:资料未说明具体平台支持、配置细节或收费信息,相关事实暂未提供;实际执行效果取决于仓库现有 README 规范与校验环境。