xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-04 12:50:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: document how to auto-trigger /add_docs via pr_commands

Browse Source
This commit is contained in:
jaexxin
2025-05-19 21:17:59 +09:00
parent e692dee66a
commit 3f4fac1232
1 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/docs/tools/documentation.md
View File

@ -26,6 +26,10 @@ You can state a name of a specific component in the PR to get documentation only
/add_docs component_name /add_docs component_name
``` ```
## Manual triggering
Comment `/add_docs` on a PR to invoke it manually.
## Automatic triggering ## Automatic triggering
To automatically run the `add_docs` tool when a pull request is opened, configure your `.pr_agent.yaml` or `configuration.toml` as follows: To automatically run the `add_docs` tool when a pull request is opened, configure your `.pr_agent.yaml` or `configuration.toml` as follows:
@ -33,15 +37,16 @@ To automatically run the `add_docs` tool when a pull request is opened, configur
```toml ```toml
[github_app] [github_app]
pr_commands = [ pr_commands = [
"/describe", "/add_docs",
"/review", ...
"/improve",
"/add_docs"
] ]
``` ```
The `pr_commands` list defines commands that run automatically when a PR is opened.
This applies only if the Qodo Merge GitHub App is installed and active for the repository.
!!! note !!! note
This behavior is **opt-in**; by default `/add_docs` only runs on manual invocation. By default, /add_docs is not triggered automatically. You must explicitly include it in pr_commands to enable this behavior.
## Configuration options ## Configuration options