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

docs: clarify distinction between PR-Agent and Qodo Merge throughout documentation

Browse Source
This commit is contained in:
mrT23
2025-01-22 21:11:46 +02:00
parent c537e9ff66
commit e571841b5c
13 changed files with 130 additions and 219 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/tools/help.md
View File

@ -1,6 +1,6 @@
## Overview
The `help` tool provides a list of all the available tools and their descriptions.
For Qodo Merge Pro users, it also enables to trigger each tool by checking the relevant box.
For Qodo Merge users, it also enables to trigger each tool by checking the relevant box.
It can be invoked manually by commenting on any PR:
```

4
docs/docs/tools/improve.md
View File

@ -9,7 +9,7 @@ The tool can be triggered automatically every time a new PR is [opened](../usage
![code_suggestions_as_comment_open.png](https://codium.ai/images/pr_agent/code_suggestions_as_comment_open.png){width=512}
Note that the `Apply this suggestion` checkbox, which interactively converts a suggestion into a commitable code comment, is available only for Qodo Merge Pro 💎 users.
Note that the `Apply this suggestion` checkbox, which interactively converts a suggestion into a commitable code comment, is available only for Qodo Merge💎 users.
## Example usage
@ -54,7 +54,7 @@ num_code_suggestions_per_chunk = ...
### Assessing Impact 💎
Note that Qodo Merge pro tracks two types of implementations:
Note that Qodo Merge tracks two types of implementations:
- Direct implementation - when the user directly applies the suggestion by clicking the `Apply` checkbox.
- Indirect implementation - when the user implements the suggestion in their IDE environment. In this case, Qodo Merge will utilize, after each commit, a dedicated logic to identify if a suggestion was implemented, and will mark it as implemented.

2
docs/docs/tools/index.md
View File

@ -20,4 +20,4 @@ Here is a list of Qodo Merge tools, each with a dedicated page that explains how
| **💎 [Improve Component (`/improve_component component_name`](./improve_component.md))** | Generates code suggestions for a specific code component that changed in the PR |
| **💎 [CI Feedback (`/checks ci_job`](./ci_feedback.md))** | Automatically generates feedback and analysis for a failed CI job |
| **💎 [Implement (`/implement`](./implement.md))** | Generates implementation code from review suggestions |
Note that the tools marked with 💎 are available only for Qodo Merge Pro users.
Note that the tools marked with 💎 are available only for Qodo Merge users.