From 31620a82c04b0b40ea55b398e6ad5bf83f18401c Mon Sep 17 00:00:00 2001 From: jaexxin Date: Mon, 19 May 2025 17:34:48 +0900 Subject: [PATCH 1/5] docs: document how to auto-trigger /add_docs via pr_commands --- docs/docs/tools/documentation.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/docs/tools/documentation.md b/docs/docs/tools/documentation.md index 247d5d6d..293cabb0 100644 --- a/docs/docs/tools/documentation.md +++ b/docs/docs/tools/documentation.md @@ -26,6 +26,25 @@ You can state a name of a specific component in the PR to get documentation only /add_docs component_name ``` +## 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: + +```toml +[github_app] +pr_commands = [ + "/describe", + "/review", + "/improve", + "/add_docs" +] +``` + +!!! note + This behavior is **opt-in**; by default `/add_docs` only runs on manual invocation. + + + ## Configuration options - `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`. From e692dee66addca469bb0a721cf02e9ea325f7e06 Mon Sep 17 00:00:00 2001 From: jaexxin Date: Mon, 19 May 2025 17:39:55 +0900 Subject: [PATCH 2/5] docs: document how to auto-trigger /add_docs via pr_commands --- docs/docs/tools/documentation.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/docs/tools/documentation.md b/docs/docs/tools/documentation.md index 293cabb0..307c8131 100644 --- a/docs/docs/tools/documentation.md +++ b/docs/docs/tools/documentation.md @@ -43,8 +43,6 @@ pr_commands = [ !!! note This behavior is **opt-in**; by default `/add_docs` only runs on manual invocation. - - ## Configuration options - `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`. From 3f4fac1232697ab96ee3c0c9cb630c6a86eb67cb Mon Sep 17 00:00:00 2001 From: jaexxin Date: Mon, 19 May 2025 21:17:59 +0900 Subject: [PATCH 3/5] docs: document how to auto-trigger /add_docs via pr_commands --- docs/docs/tools/documentation.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/docs/tools/documentation.md b/docs/docs/tools/documentation.md index 307c8131..ff6a099c 100644 --- a/docs/docs/tools/documentation.md +++ b/docs/docs/tools/documentation.md @@ -26,6 +26,10 @@ You can state a name of a specific component in the PR to get documentation only /add_docs component_name ``` +## Manual triggering + +Comment `/add_docs` on a PR to invoke it manually. + ## 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: @@ -33,15 +37,16 @@ To automatically run the `add_docs` tool when a pull request is opened, configur ```toml [github_app] pr_commands = [ - "/describe", - "/review", - "/improve", - "/add_docs" + "/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 - 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 From 5e40b3962a6dc926c1e5bb49d04ebdc18e70c406 Mon Sep 17 00:00:00 2001 From: jaexxin Date: Mon, 19 May 2025 22:22:22 +0900 Subject: [PATCH 4/5] docs: document how to auto-trigger /add_docs via pr_commands --- docs/docs/tools/documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/tools/documentation.md b/docs/docs/tools/documentation.md index ff6a099c..63dac8c3 100644 --- a/docs/docs/tools/documentation.md +++ b/docs/docs/tools/documentation.md @@ -43,7 +43,7 @@ pr_commands = [ ``` 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. +Since this is under the [github_app] section, it only applies when using the Qodo Merge GitHub App in GitHub environments. !!! note By default, /add_docs is not triggered automatically. You must explicitly include it in pr_commands to enable this behavior. From a315779713f9e26ab43e1f9d595112e214e8c9b2 Mon Sep 17 00:00:00 2001 From: jaexxin Date: Tue, 20 May 2025 00:23:44 +0900 Subject: [PATCH 5/5] docs: document how to auto-trigger /add_docs via pr_commands --- docs/docs/tools/documentation.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/docs/tools/documentation.md b/docs/docs/tools/documentation.md index 63dac8c3..47222f51 100644 --- a/docs/docs/tools/documentation.md +++ b/docs/docs/tools/documentation.md @@ -32,7 +32,8 @@ Comment `/add_docs` on a PR to invoke it manually. ## 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, define in a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/): + ```toml [github_app]