diff --git a/docs/docs/core-abilities/incremental_update.md b/docs/docs/core-abilities/incremental_update.md new file mode 100644 index 00000000..3813fb73 --- /dev/null +++ b/docs/docs/core-abilities/incremental_update.md @@ -0,0 +1,33 @@ +# Incremental Update 💎 + +`Supported Git Platforms: GitHub` + +## Overview +The Incremental Update feature helps users focus on feedback for their newest changes, making large PRs more manageable. + +### How it works + +=== "Update Option on Subsequent Commits" + ![code_suggestions_update](https://www.qodo.ai/images/pr_agent/inc_update_before.png){width=512} + +=== "Generation of Incremental Update" + ![code_suggestions_inc_update_result](https://www.qodo.ai/images/pr_agent/inc_update_shown.png){width=512} + +___ + +Whenever new commits are pushed following a recent code suggestions report for this PR, an Update button appears (as seen above). + +Once the user clicks on the button: + +- The `improve` tool identifies the new changes (the "delta") +- Provides suggestions on these recent changes +- Combines these suggestions with the overall PR feedback, prioritizing delta-related comments +- Marks delta-related comments with a textual indication followed by an asterisk (*) with a link to this page, so they can easily be identified + +### Benefits for Developers + +- Focus on what matters: See feedback on newest code first +- Clearer organization: Comments on recent changes are clearly marked +- Better workflow: Address feedback more systematically, starting with recent changes + + diff --git a/docs/docs/core-abilities/index.md b/docs/docs/core-abilities/index.md index 9af26e2e..b97260ee 100644 --- a/docs/docs/core-abilities/index.md +++ b/docs/docs/core-abilities/index.md @@ -8,6 +8,7 @@ Qodo Merge utilizes a variety of core abilities to provide a comprehensive and e - [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/) - [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/) - [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/) - [RAG context enrichment](https://qodo-merge-docs.qodo.ai/core-abilities/rag_context_enrichment/) diff --git a/docs/docs/index.md b/docs/docs/index.md index 8dd7c955..79a06e5d 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -67,6 +67,7 @@ PR-Agent and Qodo Merge offers extensive pull request functionalities across var | | [Impact Evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) 💎 | ✅ | ✅ | | | | | [Code Validation 💎](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/) | ✅ | ✅ | ✅ | ✅ | | | [Auto Best Practices 💎](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/) | ✅ | | | | +| | [Incremental Update 💎](https://qodo-merge-docs.qodo.ai/core-abilities/incremental_update/) | ✅ | | | | !!! note "💎 means Qodo Merge only" All along the documentation, 💎 marks a feature available only in [Qodo Merge](https://www.codium.ai/pricing/){:target="_blank"}, and not in the open-source version. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 8525fdee..a25c081b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -49,6 +49,7 @@ nav: - Dynamic context: 'core-abilities/dynamic_context.md' - Fetching ticket context: 'core-abilities/fetching_ticket_context.md' - Impact evaluation: 'core-abilities/impact_evaluation.md' + - Incremental Update: 'core-abilities/incremental_update.md' - Interactivity: 'core-abilities/interactivity.md' - Local and global metadata: 'core-abilities/metadata.md' - RAG context enrichment: 'core-abilities/rag_context_enrichment.md'