DeepDocs 的深度扫描功能主要用于全面检查代码库中的所有文档,批量修复过时内容。这对于长期未更新文档的项目尤为有用,可以一次性解决大量文档与代码不一致的问题。
深度扫描的主要特点包括:
- 全面分析整个代码库,识别所有需要更新的文档。
- 生成包含所有变更的独立分支,分支名格式为 deepdocs-deepscan-<branch>-<commit_sha>。
- 提供详细的变更报告,列明每个更新的文件、变更原因以及关联的代码提交。
触发深度扫描的方法很简单:只需修改 deepdocs.yml 配置文件中的 reinit 字符串(任意随机字符串),然后提交这个修改。DeepDocs 检测到 reinit 的变化后,就会自动启动一次全面扫描。
这个功能特别适合项目重构后需要更新大量文档,或者接手遗留项目时需要清理技术债务的场景。
この答えは記事から得たものである。DeepDocs:コードドキュメントを自動更新するGitHubのAIツールについて