DeepDocs

DeepDocs 是一个 GitHub AI 代理，能够让您的技术文档与代码库完美同步。当您提交代码更改时，它会扫描整个仓库，查找需要更新的文档，并自动进行必要的修改。

与从头生成文件的传统文档生成器不同，DeepDocs 仅更新需要更改的部分，同时保持您原有的风格和格式不变。它兼容 Docusaurus、Mintlify、MkDocs 和 Read the Docs 等流行的文档工具。

DeepDocs 为个人项目提供免费版本，每月包含 10 次扫描额度；为频繁发布代码的团队提供专业版，每月提供 100 次扫描额度，并支持同时管理最多五个文档文件或文件夹。

开始使用 DeepDocs 非常简单，大约只需两分钟。步骤如下：

• 从 GitHub Marketplace 在包含源代码和文档的仓库中安装 DeepDocs 应用程序。如果您的文档存放在单独的仓库中，也请在那里安装。

• 在主分支根目录下创建一个名为 deepdocs.yml 的配置文件。该文件告诉 DeepDocs 您希望与代码保持同步的文档文件或文件夹。

• 将配置文件提交到您的仓库。DeepDocs 会立即对您的代码库进行完整扫描，检测任何过时的文档，并向您发送包含建议修复方案的详细电子邮件报告。

• 初始设置完成后，DeepDocs 会在每次未来提交时自动运行，扫描您的更改，并在单独的分支中更新相关文档，供您在合并前审查。

• 每次提交自动更新文档

• 每次代码变更时完整扫描仓库

• 仅更新过时部分，同时保留格式

• 详细的文档变更报告

• 与 GitHub 原生集成，支持拉取请求工作流

• 支持单体仓库和独立文档仓库

• 支持 Docusaurus、Mintlify、MkDocs、Read the Docs

• 智能更新，无需完全重写

• 扫描结果邮件通知

• 简易的两分钟设置流程