Skip to main content
GitHub GitLab Bitbucket
Git Integration (formerly Qodo Merge) – AI code review agents for pull requests. This documentation describes the Qodo v1 experience. For the Qodo v2 documentation, click here.
The help_docs tool can answer a free-text question based on your git documentation folder.

How to use the help_docs tool

Manual usage Comment on the PR:
Automatic usage To run the tool automatically when a new issue is opened, add it to your configuration file:
The tool assumes by default that the documentation is located in the root of the repository, at the /docs folder. However, this can be customized by setting the docs_path configuration option:

Learn more about automatic usage of tools.

Run automatically when a new issue is opened

You can configure Qodo to run help_docs automatically on any newly created issue. This can be useful for providing immediate feedback to users who open issues with questions on open-source projects with extensive documentation.
1
Create a GitHub action, such as: .github/workflows/help_docs.yml
2
Add to your YAML file:
3
Continue adding secrets and relevant configurations, such as repo_url and docs_path.
4
Merge the changes to your main branch.
5
Done! When a new issue related to the repository’s documentation is opened in your repository, you will see a comment from the github-actions bot with an auto response.

Configuration options

Configure the help_docs tool by setting configurations under the pr_help_docs part in your configuration file.

Example usage

Asking a question about another repository:
Response: