Skip to content

Commit cb47cd5

Browse files
committed
Update interactivity documentation with consistent formatting and links
1 parent 99d88f8 commit cb47cd5

File tree

3 files changed

+9
-27
lines changed

3 files changed

+9
-27
lines changed

docs/docs/core-abilities/interactivity.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,16 @@
55
## Overview
66

77
Qodo Merge transforms static code reviews into interactive experiences by enabling direct actions from pull request (PR) comments.
8-
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.
8+
Developers can immediately trigger actions and apply changes with simple checkbox clicks.
9+
10+
This focused workflow maintains context while dramatically reducing the time between PR creation and final merge.
911
The approach eliminates manual steps, provides clear visual indicators, and creates immediate feedback loops all within the same interface.
1012

1113
## Key Interactive Features
1214

13-
### 1\. Interactive `/Improve` Tool
15+
### 1\. Interactive `/improve` Tool
1416

15-
The `/improve` command delivers a comprehensive interactive experience:
17+
The [`/improve`](https://qodo-merge-docs.qodo.ai/tools/improve/) command delivers a comprehensive interactive experience:
1618

1719
- _**Apply this suggestion**_: Clicking this checkbox instantly converts a suggestion into a committable code change
1820

@@ -23,9 +25,9 @@ The `/improve` command delivers a comprehensive interactive experience:
2325
- _**Author self-review**_: Interactive acknowledgment that developers have opened and reviewed collapsed suggestions
2426

2527

26-
### 2\. Interactive `/Analyze` Tool
28+
### 2\. Interactive `/analyze` Tool
2729

28-
The `/analyze` command provides component-level analysis with interactive options for each identified code component:
30+
The [`/analyze`](https://qodo-merge-docs.qodo.ai/tools/analyze/) command provides component-level analysis with interactive options for each identified code component:
2931

3032
- Interactive checkboxes to generate tests, documentation, and code suggestions for specific components
3133

@@ -34,8 +36,8 @@ The `/analyze` command provides component-level analysis with interactive option
3436
- Component-specific actions that trigger only for the selected elements, providing focused assistance
3537

3638

37-
### 3\. Interactive `/Help` Tool
39+
### 3\. Interactive `/help` Tool
3840

39-
The `/help` command not only lists available tools and their descriptions but also enables immediate tool invocation through interactive checkboxes.
41+
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.
4042
When a user checks a tool's checkbox, Qodo Merge instantly triggers that tool without requiring additional commands.
4143
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.

docs/docs/usage-guide/additional_configurations.md

-19
Original file line numberDiff line numberDiff line change
@@ -120,25 +120,6 @@ Increasing this number provides more context to the model, but will also increas
120120

121121
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.
122122

123-
124-
## Editing the prompts
125-
126-
The prompts for the various Qodo Merge tools are defined in the `pr_agent/settings` folder.
127-
In practice, the prompts are loaded and stored as a standard setting object.
128-
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.
129-
130-
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:
131-
```
132-
[pr_description_prompt]
133-
system="""
134-
...
135-
"""
136-
user="""
137-
...
138-
"""
139-
```
140-
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).
141-
142123
## Log Level
143124

144125
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.

docs/docs/usage-guide/index.md

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

0 commit comments

Comments
 (0)