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:
/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 runhelp_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.yml2
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 thehelp_docs tool by setting configurations under the pr_help_docs part in your configuration file.
Example usage
Asking a question about another repository:
