From cb47cd51445719663e7f9cf7032af94e17191224 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Fri, 4 Apr 2025 11:36:40 +0300 Subject: [PATCH] Update interactivity documentation with consistent formatting and links --- docs/docs/core-abilities/interactivity.md | 16 +++++++++------- .../usage-guide/additional_configurations.md | 19 ------------------- docs/docs/usage-guide/index.md | 1 - 3 files changed, 9 insertions(+), 27 deletions(-) diff --git a/docs/docs/core-abilities/interactivity.md b/docs/docs/core-abilities/interactivity.md index e0c2a196..8f7908f6 100644 --- a/docs/docs/core-abilities/interactivity.md +++ b/docs/docs/core-abilities/interactivity.md @@ -5,14 +5,16 @@ ## Overview 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. ## 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 @@ -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 -### 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 @@ -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 -### 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. 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. diff --git a/docs/docs/usage-guide/additional_configurations.md b/docs/docs/usage-guide/additional_configurations.md index c24cb777..578223a7 100644 --- a/docs/docs/usage-guide/additional_configurations.md +++ b/docs/docs/usage-guide/additional_configurations.md @@ -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. - -## 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 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. diff --git a/docs/docs/usage-guide/index.md b/docs/docs/usage-guide/index.md index ce896893..087dd772 100644 --- a/docs/docs/usage-guide/index.md +++ b/docs/docs/usage-guide/index.md @@ -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) - [Changing a model](./additional_configurations.md#changing-a-model) - [Patch Extra Lines](./additional_configurations.md#patch-extra-lines) - - [Editing the prompts](./additional_configurations.md#editing-the-prompts) - [Qodo Merge Models](./qodo_merge_models)