diff --git a/docs/docs/core-abilities/index.md b/docs/docs/core-abilities/index.md index 1e198292..ffb50cb6 100644 --- a/docs/docs/core-abilities/index.md +++ b/docs/docs/core-abilities/index.md @@ -7,7 +7,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/) - [Self-reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/) - [Impact evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) -- [RAG Context Enrichment](https://qodo-merge-docs.qodo.ai/core-abilities/rag_context_enrichment/) +- [RAG context enrichment](https://qodo-merge-docs.qodo.ai/core-abilities/rag_context_enrichment/) - [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/) - [Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) - [Code validation](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/) diff --git a/docs/docs/core-abilities/interactivity.md b/docs/docs/core-abilities/interactivity.md index e107f781..e0c2a196 100644 --- a/docs/docs/core-abilities/interactivity.md +++ b/docs/docs/core-abilities/interactivity.md @@ -1,2 +1,41 @@ -## Interactive invocation 💎 -TBD +# Interactivity + +`Supported Git Platforms: GitHub, GitLab` + +## 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. +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 + +The `/improve` command delivers a comprehensive interactive experience: + +- _**Apply this suggestion**_: Clicking this checkbox instantly converts a suggestion into a committable code change + +- _**More**_: Triggers additional suggestions generation while keeping each suggestion focused and relevant as the original set + +- _**Update**_: Triggers a re-analysis of the code, providing updated suggestions based on the latest changes + +- _**Author self-review**_: Interactive acknowledgment that developers have opened and reviewed collapsed suggestions + + +### 2\. Interactive `/Analyze` Tool + +The `/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 + +- On-demand similar code search that activates when a checkbox is clicked + +- Component-specific actions that trigger only for the selected elements, providing focused assistance + + +### 3\. Interactive `/Help` Tool + +The `/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/mkdocs.yml b/docs/mkdocs.yml index ed7c3096..7ed78331 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -47,12 +47,12 @@ nav: - Dynamic context: 'core-abilities/dynamic_context.md' - Self-reflection: 'core-abilities/self_reflection.md' - Impact evaluation: 'core-abilities/impact_evaluation.md' - - RAG Context Enrichment: 'core-abilities/rag_context_enrichment.md' + - RAG context enrichment: 'core-abilities/rag_context_enrichment.md' - Static code analysis: 'core-abilities/static_code_analysis.md' - Compression strategy: 'core-abilities/compression_strategy.md' - Code validation: 'core-abilities/code_validation.md' - Interactivity: 'core-abilities/interactivity.md' - - Code Fine-tuning Benchmark: 'finetuning_benchmark/index.md' + - Code fine-tuning benchmark: 'finetuning_benchmark/index.md' - Chrome Extension: - Qodo Merge Chrome Extension: 'chrome-extension/index.md' - Features: 'chrome-extension/features.md'