安装和配置 DeepDocs 非常简单,只需以下几个步骤:
- Instalando o aplicativo GitHub:在 GitHub 仓库中,进入 Settings > GitHub Apps,在 Marketplace 搜索 DeepDocsAI,点击 Configure 并选择需要监控的代码仓库。
- Criação de arquivos de configuração:在代码仓库的根目录创建名为 deepdocs.yml 的配置文件。示例配置如下:
target: - url: "docs/" reinit: "random-string" ignore: []
其中,target 指定监控的文档路径,reinit 用于手动触发扫描,ignore 可指定忽略的文件。
- 提交配置文件:将 deepdocs.yml 提交到需要监控的分支(如 main 或 dev),DeepDocs 会自动触发初始深度扫描。
配置完成后,DeepDocs 会开始监控代码变更并自动更新相关文档,所有更新会以新分支的形式提交,方便团队审查。
Essa resposta foi extraída do artigoDeepDocs: a ferramenta de IA do GitHub que atualiza automaticamente a documentação do códigoO