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

docs: add dedicated "Chat on code suggestions" core ability page and update related documentation

Browse Source 
- Introduced a new core abilities page detailing the "Chat on code suggestions" feature, including setup, activation, and usage patterns.
- Removed the corresponding section from the improve tool documentation to avoid duplication.
- Updated the core abilities index and mkdocs navigation to include the new page.
- Improved formatting in the implement tool documentation for clarity and consistency.
This commit is contained in:
ofir-frd
2025-05-28 09:12:13 +03:00
parent 9f9548395f
commit fd1a27c2ac
5 changed files with 84 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
docs/docs/tools/implement.md
View File

@ -7,50 +7,50 @@ It leverages LLM technology to transform PR comments and review suggestions into
## Usage Scenarios
### For Reviewers
=== "For Reviewers"
Reviewers can request code changes by:
Reviewers can request code changes by:
1. Selecting the code block to be modified.
2. Adding a comment with the syntax:
1. Selecting the code block to be modified.
2. Adding a comment with the syntax:
```
/implement <code-change-description>
```
```
/implement <code-change-description>
```
![implement1](https://codium.ai/images/pr_agent/implement1.png){width=640}
![implement1](https://codium.ai/images/pr_agent/implement1.png){width=640}
### For PR Authors
=== "For PR Authors"
PR authors can implement suggested changes by replying to a review comment using either: <br>
PR authors can implement suggested changes by replying to a review comment using either:
1. Add specific implementation details as described above
1. Add specific implementation details as described above
```
/implement <code-change-description>
```
```
/implement <code-change-description>
```
2. Use the original review comment as instructions
2. Use the original review comment as instructions
```
/implement
```
```
/implement
```
![implement2](https://codium.ai/images/pr_agent/implement2.png){width=640}
![implement2](https://codium.ai/images/pr_agent/implement2.png){width=640}
### For Referencing Comments
=== "For Referencing Comments"
You can reference and implement changes from any comment by:
You can reference and implement changes from any comment by:
```
/implement <link-to-review-comment>
```
```
/implement <link-to-review-comment>
```
![implement3](https://codium.ai/images/pr_agent/implement3.png){width=640}
![implement3](https://codium.ai/images/pr_agent/implement3.png){width=640}
Note that the implementation will occur within the review discussion thread.
Note that the implementation will occur within the review discussion thread.
**Configuration options**
## Configuration options
- Use `/implement` to implement code change within and based on the review discussion.
- Use `/implement <code-change-description>` inside a review discussion to implement specific instructions.