Installing and configuring DeepDocs is very simple and requires only the following steps:
- Installing the GitHub app: In a GitHub repository, go to Settings > GitHub Apps, search the Marketplace for DeepDocsAI, click Configure and select the code repository you want to monitor.
- Creating Configuration Files: Create a configuration file named deepdocs.yml in the root directory of your code repository. A sample configuration is shown below:
target: - url: "docs/" reinit: "random-string" ignore: []
Among them, target specifies the path of the monitored document, reinit is used to trigger scanning manually, and ignore specifies the files to be ignored.
- Submit Configuration File: Commit deepdocs.yml to the branch to be monitored (e.g. main or dev) and DeepDocs will automatically trigger an initial deep scan.
Once configured, DeepDocs will start monitoring code changes and automatically update the relevant documentation, with all updates committed as new branches for easy review by the team.
This answer comes from the articleDeepDocs: the GitHub AI tool that automatically updates code documentationThe
May not be reproduced without permission:AI productivity tools " How to install and configure DeepDocs on GitHub?
English 
简体中文 
日本語 
Deutsch 
Português do Brasil