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

Update interactivity documentation with consistent formatting and links

Browse Source
This commit is contained in:
mrT23
2025-04-04 11:36:40 +03:00
parent 99d88f8d1d
commit cb47cd5144
3 changed files with 9 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/docs/core-abilities/interactivity.md
View File

@ -5,14 +5,16 @@
## Overview ## Overview
Qodo Merge transforms static code reviews into interactive experiences by enabling direct actions from pull request (PR) comments. Qodo Merge transforms static code reviews into interactive experiences by enabling direct actions from pull request (PR) comments.
Developers can immediately trigger actions and apply changes with simple checkbox clicks. This focused workflow maintains context while dramatically reducing the time between PR creation and final merge. Developers can immediately trigger actions and apply changes with simple checkbox clicks.
This focused workflow maintains context while dramatically reducing the time between PR creation and final merge.
The approach eliminates manual steps, provides clear visual indicators, and creates immediate feedback loops all within the same interface. The approach eliminates manual steps, provides clear visual indicators, and creates immediate feedback loops all within the same interface.
## Key Interactive Features ## Key Interactive Features
### 1\. Interactive `/Improve` Tool ### 1\. Interactive `/improve` Tool
The `/improve` command delivers a comprehensive interactive experience: The [`/improve`](https://qodo-merge-docs.qodo.ai/tools/improve/) command delivers a comprehensive interactive experience:
- _**Apply this suggestion**_: Clicking this checkbox instantly converts a suggestion into a committable code change - _**Apply this suggestion**_: Clicking this checkbox instantly converts a suggestion into a committable code change
@ -23,9 +25,9 @@ The `/improve` command delivers a comprehensive interactive experience:
- _**Author self-review**_: Interactive acknowledgment that developers have opened and reviewed collapsed suggestions - _**Author self-review**_: Interactive acknowledgment that developers have opened and reviewed collapsed suggestions
### 2\. Interactive `/Analyze` Tool ### 2\. Interactive `/analyze` Tool
The `/analyze` command provides component-level analysis with interactive options for each identified code component: The [`/analyze`](https://qodo-merge-docs.qodo.ai/tools/analyze/) command provides component-level analysis with interactive options for each identified code component:
- Interactive checkboxes to generate tests, documentation, and code suggestions for specific components - Interactive checkboxes to generate tests, documentation, and code suggestions for specific components
@ -34,8 +36,8 @@ The `/analyze` command provides component-level analysis with interactive option
- Component-specific actions that trigger only for the selected elements, providing focused assistance - Component-specific actions that trigger only for the selected elements, providing focused assistance
### 3\. Interactive `/Help` Tool ### 3\. Interactive `/help` Tool
The `/help` command not only lists available tools and their descriptions but also enables immediate tool invocation through interactive checkboxes. The [`/help`](https://qodo-merge-docs.qodo.ai/tools/help/) command not only lists available tools and their descriptions but also enables immediate tool invocation through interactive checkboxes.
When a user checks a tool's checkbox, Qodo Merge instantly triggers that tool without requiring additional commands. When a user checks a tool's checkbox, Qodo Merge instantly triggers that tool without requiring additional commands.
This transforms the standard help menu into an interactive launch pad for all Qodo Merge capabilities, eliminating context switching by keeping developers within their PR workflow. This transforms the standard help menu into an interactive launch pad for all Qodo Merge capabilities, eliminating context switching by keeping developers within their PR workflow.

19
docs/docs/usage-guide/additional_configurations.md
View File

@ -120,25 +120,6 @@ Increasing this number provides more context to the model, but will also increas
If the PR is too large (see [PR Compression strategy](https://github.com/Codium-ai/pr-agent/blob/main/PR_COMPRESSION.md)), Qodo Merge may automatically set this number to 0, and will use the original git patch. If the PR is too large (see [PR Compression strategy](https://github.com/Codium-ai/pr-agent/blob/main/PR_COMPRESSION.md)), Qodo Merge may automatically set this number to 0, and will use the original git patch.
## Editing the prompts
The prompts for the various Qodo Merge tools are defined in the `pr_agent/settings` folder.
In practice, the prompts are loaded and stored as a standard setting object.
Hence, editing them is similar to editing any other configuration value - just place the relevant key in `.pr_agent.toml`file, and override the default value.
For example, if you want to edit the prompts of the [describe](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/pr_description_prompts.toml) tool, you can add the following to your `.pr_agent.toml` file:
```
[pr_description_prompt]
system="""
...
"""
user="""
...
"""
```
Note that the new prompt will need to generate an output compatible with the relevant [post-process function](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/tools/pr_description.py#L137).
## Log Level ## Log Level
Qodo Merge allows you to control the verbosity of logging by using the `log_level` configuration parameter. This is particularly useful for troubleshooting and debugging issues with your PR workflows. Qodo Merge allows you to control the verbosity of logging by using the `log_level` configuration parameter. This is particularly useful for troubleshooting and debugging issues with your PR workflows.

1
docs/docs/usage-guide/index.md
View File

@ -23,5 +23,4 @@ It includes information on how to adjust Qodo Merge configurations, define which
- [Working with large PRs](./additional_configurations.md#working-with-large-prs) - [Working with large PRs](./additional_configurations.md#working-with-large-prs)
- [Changing a model](./additional_configurations.md#changing-a-model) - [Changing a model](./additional_configurations.md#changing-a-model)
- [Patch Extra Lines](./additional_configurations.md#patch-extra-lines) - [Patch Extra Lines](./additional_configurations.md#patch-extra-lines)
- [Editing the prompts](./additional_configurations.md#editing-the-prompts)
- [Qodo Merge Models](./qodo_merge_models) - [Qodo Merge Models](./qodo_merge_models)