From 497396eaebd26f615af5a228cf894b9d1e497535 Mon Sep 17 00:00:00 2001 From: Eyal Sharon Date: Tue, 29 Jul 2025 19:31:47 +0300 Subject: [PATCH] Add high-level suggestions to docs --- .../core-abilities/high_level_suggestions.md | 19 +++++++++++++++++++ docs/docs/core-abilities/index.md | 1 + docs/docs/recent_updates/index.md | 1 + 3 files changed, 21 insertions(+) create mode 100644 docs/docs/core-abilities/high_level_suggestions.md diff --git a/docs/docs/core-abilities/high_level_suggestions.md b/docs/docs/core-abilities/high_level_suggestions.md new file mode 100644 index 00000000..769875f2 --- /dev/null +++ b/docs/docs/core-abilities/high_level_suggestions.md @@ -0,0 +1,19 @@ +# High-level Suggestions 💎 + +`Supported Git Platforms: GitHub, GitLab (Both cloud & server. For server: Version 17 and above)` + +## Overview +High-level Suggestions offer a broad view of the pull request via the improve tool. +Rather than local code fixes, they may provide examples of what needs improvement as well as before and after code snippets to illustrate necessary changes and guide implementation. +### How it works + +=== "Example of a high-level suggestion + ![code_suggestions_update](https://www.qodo.ai/images/pr_agent/high_level_suggestion_closed.png){width=512} + ![code_suggestions_update](https://www.qodo.ai/images/pr_agent/high_level_suggestion_open.png){width=512} + +___ + +### Benefits for Developers + +- Help spot systematic issues in the pull request +- Give the author another review angle, while giving them the freedom on how to address the suggestion. diff --git a/docs/docs/core-abilities/index.md b/docs/docs/core-abilities/index.md index f8ac0f63..28850087 100644 --- a/docs/docs/core-abilities/index.md +++ b/docs/docs/core-abilities/index.md @@ -9,6 +9,7 @@ Qodo Merge utilizes a variety of core abilities to provide a comprehensive and e - [Code validation](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/) - [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/) - [Fetching ticket context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/) +- [High-level Suggestions](https://qodo-merge-docs.qodo.ai/core-abilities/high_level_suggestions/) - [Impact evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) - [Incremental Update](https://qodo-merge-docs.qodo.ai/core-abilities/incremental_update/) - [Interactivity](https://qodo-merge-docs.qodo.ai/core-abilities/interactivity/) diff --git a/docs/docs/recent_updates/index.md b/docs/docs/recent_updates/index.md index cbe8b8b9..e1ee3f99 100644 --- a/docs/docs/recent_updates/index.md +++ b/docs/docs/recent_updates/index.md @@ -7,6 +7,7 @@ This page summarizes recent enhancements to Qodo Merge (last three months). It also outlines our development roadmap for the upcoming three months. Please note that the roadmap is subject to change, and features may be adjusted, added, or reprioritized. === "Recent Updates" + - [2025-07-29] **High-level Suggestions**: Qodo Merge now offers up to one high-level suggestion to the table of code suggestions. ([Learn more](https://qodo-merge-docs.qodo.ai/core-abilities/high_level_suggestions/)) - [2025-07-20] **PR to Ticket**: Generate tickets in your tracking systems based on PR content. ([Learn more](https://qodo-merge-docs.qodo.ai/tools/pr_to_ticket/)) - [2025-07-17] **Compliance**: Comprehensive compliance checks for security, ticket requirements, and custom organizational rules. ([Learn more](https://qodo-merge-docs.qodo.ai/tools/compliance/)) - **Gitlab Issues Support**: Qodo Merge now supports Gitlab issues for ticket context retrieval and ticket creation.