From 96d408c42a26542fb11ebc54e9b04ee53756b38b Mon Sep 17 00:00:00 2001 From: Abhinav Kumar Date: Sat, 19 Jul 2025 09:55:35 +0530 Subject: [PATCH 1/4] fix: update documentation for tools --- docs/docs/tools/help_docs.md | 8 ++++---- docs/docs/tools/improve.md | 6 +++--- docs/docs/tools/improve_component.md | 2 +- docs/docs/tools/review.md | 4 ++-- docs/docs/tools/similar_code.md | 4 ++-- docs/docs/tools/test.md | 2 +- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/docs/tools/help_docs.md b/docs/docs/tools/help_docs.md index 308edc1d..b69966d3 100644 --- a/docs/docs/tools/help_docs.md +++ b/docs/docs/tools/help_docs.md @@ -86,10 +86,10 @@ jobs: -c "cd /app && \ echo 'Running Issue Agent action step on ISSUE_URL=$ISSUE_URL' && \ export config__git_provider='github' && \ - export github__user_token=$GITHUB_TOKEN && \ - export github__base_url=$GITHUB_API_URL && \ - export openai__key=$OPENAI_KEY && \ - python -m pr_agent.cli --issue_url=$ISSUE_URL --pr_help_docs.repo_url="..." --pr_help_docs.docs_path="..." --pr_help_docs.openai_key=$OPENAI_KEY && \help_docs \"$ISSUE_BODY\"" + export github__user_token=$GITHUB_TOKEN && \ +export github__base_url=$GITHUB_API_URL && \ +export openai__key=$OPENAI_KEY && \ +python -m pr_agent.cli --issue_url=$ISSUE_URL --pr_help_docs.repo_url="..." --pr_help_docs.docs_path="..." --pr_help_docs.openai_key=$OPENAI_KEY && help_docs "$ISSUE_BODY" ``` 3) Following completion of the remaining steps (such as adding secrets and relevant configurations, such as `repo_url` and `docs_path`) merge this change to your main branch. diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index bdc83630..b36b5332 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -80,13 +80,13 @@ Qodo Merge tracks two types of implementations for tracking implemented suggesti - 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. -![code_suggestions_assess_impact](https://codium.ai/images/pr_agent/code_suggestions_asses_impact.png){width=512} +![code_suggestions_assess_impact](https://codium.ai/images/pr_agent/code_suggestions_assess_impact.png){width=512} In post-process, Qodo Merge counts the number of suggestions that were implemented, and provides general statistics and insights about the suggestions' impact on the PR process. -![code_suggestions_assess_impact_stats_1](https://codium.ai/images/pr_agent/code_suggestions_asses_impact_stats_1.png){width=512} +![code_suggestions_assess_impact_stats_1](https://codium.ai/images/pr_agent/code_suggestions_assess_impact_stats_1.png){width=512} -![code_suggestions_assess_impact_stats_2](https://codium.ai/images/pr_agent/code_suggestions_asses_impact_stats_2.png){width=512} +![code_suggestions_assess_impact_stats_2](https://codium.ai/images/pr_agent/code_suggestions_assess_impact_stats_2.png){width=512} ## Suggestion tracking diff --git a/docs/docs/tools/improve_component.md b/docs/docs/tools/improve_component.md index 6b93b621..05f1371e 100644 --- a/docs/docs/tools/improve_component.md +++ b/docs/docs/tools/improve_component.md @@ -1,6 +1,6 @@ ## Overview -The `improve_component` tool generates code suggestions for a specific code component that changed in the PR. +The `improve_component` tool generates code suggestions for a specific code component that has changed in the PR. it can be invoked manually by commenting on any PR: ``` diff --git a/docs/docs/tools/review.md b/docs/docs/tools/review.md index a741cac9..ed6e1c7d 100644 --- a/docs/docs/tools/review.md +++ b/docs/docs/tools/review.md @@ -1,6 +1,6 @@ ## Overview -The `review` tool scans the PR code changes, and generates a list of feedbacks about the PR, aiming to aid the reviewing process. +The `review` tool scans the PR code changes, and generates feedback about the PR, aiming to aid the reviewing process.
The tool can be triggered automatically every time a new PR is [opened](../usage-guide/automations_and_usage.md#github-app-automatic-tools-when-a-new-pr-is-opened), or can be invoked manually by commenting on any PR: @@ -8,7 +8,7 @@ The tool can be triggered automatically every time a new PR is [opened](../usage /review ``` -Note that the main purpose of the `review` tool is to provide the **PR reviewer** with useful feedbacks and insights. The PR author, in contrast, may prefer to save time and focus on the output of the [improve](./improve.md) tool, which provides actionable code suggestions. +Note that the main purpose of the `review` tool is to provide the **PR reviewer** with useful feedback and insights. The PR author, in contrast, may prefer to save time and focus on the output of the [improve](./improve.md) tool, which provides actionable code suggestions. (Read more about the different personas in the PR process and how Qodo Merge aims to assist them in our [blog](https://www.codium.ai/blog/understanding-the-challenges-and-pain-points-of-the-pull-request-cycle/)) diff --git a/docs/docs/tools/similar_code.md b/docs/docs/tools/similar_code.md index 623232f7..b8c3d869 100644 --- a/docs/docs/tools/similar_code.md +++ b/docs/docs/tools/similar_code.md @@ -4,7 +4,7 @@ The similar code tool retrieves the most similar code components from inside the For example: -`Global Search` for a method called `chat_completion`: +A `Global Search` for a method called `chat_completion`: ![similar code global](https://codium.ai/images/pr_agent/similar_code_global2.png){width=768} @@ -19,7 +19,7 @@ Search result link example: ![code search result single](https://codium.ai/images/pr_agent/code_search_result_single.png){width=768} -`Organization Search`: +An `Organization Search`: ![similar code org](https://codium.ai/images/pr_agent/similar_code_org.png){width=768} diff --git a/docs/docs/tools/test.md b/docs/docs/tools/test.md index 04cc33d6..22f4df01 100644 --- a/docs/docs/tools/test.md +++ b/docs/docs/tools/test.md @@ -1,6 +1,6 @@ ## Overview -By combining LLM abilities with static code analysis, the `test` tool generate tests for a selected component, based on the PR code changes. +By combining LLM abilities with static code analysis, the `test` tool generates tests for a selected component, based on the PR code changes. It can be invoked manually by commenting on any PR: ``` From f170af4675e5d87dfde9d0d4b2514f6147509db1 Mon Sep 17 00:00:00 2001 From: Abhinav Kumar Date: Sat, 19 Jul 2025 09:59:30 +0530 Subject: [PATCH 2/4] fix: correct indentation --- docs/docs/tools/help_docs.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/docs/tools/help_docs.md b/docs/docs/tools/help_docs.md index b69966d3..19ba4180 100644 --- a/docs/docs/tools/help_docs.md +++ b/docs/docs/tools/help_docs.md @@ -86,10 +86,11 @@ jobs: -c "cd /app && \ echo 'Running Issue Agent action step on ISSUE_URL=$ISSUE_URL' && \ export config__git_provider='github' && \ - export github__user_token=$GITHUB_TOKEN && \ -export github__base_url=$GITHUB_API_URL && \ -export openai__key=$OPENAI_KEY && \ -python -m pr_agent.cli --issue_url=$ISSUE_URL --pr_help_docs.repo_url="..." --pr_help_docs.docs_path="..." --pr_help_docs.openai_key=$OPENAI_KEY && help_docs "$ISSUE_BODY" + export github__user_token=$GITHUB_TOKEN && \ + export github__base_url=$GITHUB_API_URL && \ + export openai__key=$OPENAI_KEY && \ + python -m pr_agent.cli --issue_url=$ISSUE_URL --pr_help_docs.repo_url="..." --pr_help_docs.docs_path="..." --pr_help_docs.openai_key=$OPENAI_KEY && \ + help_docs "$ISSUE_BODY" ``` 3) Following completion of the remaining steps (such as adding secrets and relevant configurations, such as `repo_url` and `docs_path`) merge this change to your main branch. From 4448e03117119599ead401aac96035d5ee0b2765 Mon Sep 17 00:00:00 2001 From: Abhinav Kumar Date: Tue, 22 Jul 2025 21:45:26 +0530 Subject: [PATCH 3/4] fix: correct image filenames in documentation for suggestion tracking --- docs/docs/tools/improve.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index b36b5332..8c792b8c 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -80,13 +80,13 @@ Qodo Merge tracks two types of implementations for tracking implemented suggesti - 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. -![code_suggestions_assess_impact](https://codium.ai/images/pr_agent/code_suggestions_assess_impact.png){width=512} +![code_suggestions_asses_impact](https://codium.ai/images/pr_agent/code_suggestions_asses_impact.png){width=512} In post-process, Qodo Merge counts the number of suggestions that were implemented, and provides general statistics and insights about the suggestions' impact on the PR process. -![code_suggestions_assess_impact_stats_1](https://codium.ai/images/pr_agent/code_suggestions_assess_impact_stats_1.png){width=512} +![code_suggestions_asses_impact_stats_1](https://codium.ai/images/pr_agent/code_suggestions_asses_impact_stats_1.png){width=512} -![code_suggestions_assess_impact_stats_2](https://codium.ai/images/pr_agent/code_suggestions_assess_impact_stats_2.png){width=512} +![code_suggestions_asses_impact_stats_2](https://codium.ai/images/pr_agent/code_suggestions_asses_impact_stats_2.png){width=512} ## Suggestion tracking From 4bb7da13767731f079f21c95a5f74433c58e6cda Mon Sep 17 00:00:00 2001 From: Abhinav Kumar Date: Tue, 22 Jul 2025 22:25:39 +0530 Subject: [PATCH 4/4] fix: correct spelling in image captions --- docs/docs/tools/improve.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index 8c792b8c..bdc83630 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -80,13 +80,13 @@ Qodo Merge tracks two types of implementations for tracking implemented suggesti - 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. -![code_suggestions_asses_impact](https://codium.ai/images/pr_agent/code_suggestions_asses_impact.png){width=512} +![code_suggestions_assess_impact](https://codium.ai/images/pr_agent/code_suggestions_asses_impact.png){width=512} In post-process, Qodo Merge counts the number of suggestions that were implemented, and provides general statistics and insights about the suggestions' impact on the PR process. -![code_suggestions_asses_impact_stats_1](https://codium.ai/images/pr_agent/code_suggestions_asses_impact_stats_1.png){width=512} +![code_suggestions_assess_impact_stats_1](https://codium.ai/images/pr_agent/code_suggestions_asses_impact_stats_1.png){width=512} -![code_suggestions_asses_impact_stats_2](https://codium.ai/images/pr_agent/code_suggestions_asses_impact_stats_2.png){width=512} +![code_suggestions_assess_impact_stats_2](https://codium.ai/images/pr_agent/code_suggestions_asses_impact_stats_2.png){width=512} ## Suggestion tracking