Merge pull request #1682 from qodo-ai/of/extend-rag-chapter

docs: Add RAG applications and alphabetize documentation

docs/docs/core-abilities/index.md

@@ -1,18 +1,18 @@
 # Core Abilities
 Qodo Merge utilizes a variety of core abilities to provide a comprehensive and efficient code review experience. These abilities include:
 
-- [Fetching ticket context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/)
 - [Auto best practices](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/)
-- [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/)
-- [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/)
-- [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/)
-- [Interactivity](https://qodo-merge-docs.qodo.ai/core-abilities/interactivity/)
 - [Code fine-tuning benchmark](https://qodo-merge-docs.qodo.ai/finetuning_benchmark/)
+- [Code validation](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/)
+- [Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/)
+- [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/)
+- [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/)
+- [Self-reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/)
+- [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/)
 
 ## Blogs
 

docs/docs/core-abilities/interactivity.md

@@ -16,7 +16,7 @@ The approach eliminates manual steps, provides clear visual indicators, and crea
 
 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
+- _**Apply this suggestion**_: Clicking this checkbox instantly converts a suggestion into a committable code change. When committed to the PR, changes made to code that was flagged for improvement will be marked with a check mark, allowing developers to easily track and review implemented recommendations.
 
 - _**More**_: Triggers additional suggestions generation while keeping each suggestion focused and relevant as the original set
 

docs/docs/core-abilities/rag_context_enrichment.md

@@ -6,6 +6,7 @@
     - RAG is available only for Qodo enterprise plan users, with single tenant or on-premises setup.
     - Database setup and codebase indexing must be completed before proceeding. [Contact support](https://www.qodo.ai/contact/) for more information.
 
+
 ## Overview
 
 ### What is RAG Context Enrichment?
@@ -16,6 +17,7 @@ A feature that enhances AI analysis by retrieving and referencing relevant code
 
 Using Retrieval-Augmented Generation (RAG), it searches your configured repositories for contextually relevant code segments, enriching pull request (PR) insights and accelerating review accuracy.
 
+
 ## Getting started
 
 ### Configuration options
@@ -39,10 +41,29 @@ enable_rag=true
       </tr>
     </table>
 
+### Applications
 
-References from the repository will be shown in a collapsible bookmark, allowing you to easily access relevant code snippets:
+#### 1\. The `/review` Tool
+
+The [`/review`](https://qodo-merge-docs.qodo.ai/tools/review/) tool offers the _Focus area from RAG data_ which contains feedback based on the RAG references analysis. 
+The complete list of references found relevant to the PR will be shown in the _References_ section, helping developers understand the broader context by exploring the provided references.
+
+![References](https://codium.ai/images/pr_agent/rag_review.png){width=640}
+
+#### 2\. The `/implement` Tool
+
+The [`/implement`](https://qodo-merge-docs.qodo.ai/tools/implement/) tool utilizes the RAG feature to provide comprehensive context of the repository codebase, allowing it to generate more refined code output.
+The _References_ section contains links to the content used to support the code generation.
+
+![References](https://codium.ai/images/pr_agent/rag_implement.png){width=640}
+
+#### 3\. The `/ask` Tool
+
+The [`/ask`](https://qodo-merge-docs.qodo.ai/tools/ask/) tool can access broader repository context through the RAG feature when answering questions that go beyond the PR scope alone.
+The _References_ section displays the additional repository content consulted to formulate the answer.
+
+![References](https://codium.ai/images/pr_agent/rag_ask.png){width=640}
 
-![References](https://codium.ai/images/pr_agent/rag_context_enrichment_references.png){width=640}
 
 ## Limitations
 

docs/mkdocs.yml

@@ -41,18 +41,18 @@ nav:
     - 💎 Implement: 'tools/implement.md'
   - Core Abilities:
       - 'core-abilities/index.md'
-      - Fetching ticket context: 'core-abilities/fetching_ticket_context.md'
       - Auto best practices: 'core-abilities/auto_best_practices.md'
-      - Local and global metadata: 'core-abilities/metadata.md'
-      - 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'
-      - 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 validation: 'core-abilities/code_validation.md'
+      - Compression strategy: 'core-abilities/compression_strategy.md'
+      - Dynamic context: 'core-abilities/dynamic_context.md'
+      - Fetching ticket context: 'core-abilities/fetching_ticket_context.md'
+      - Impact evaluation: 'core-abilities/impact_evaluation.md'
+      - Interactivity: 'core-abilities/interactivity.md'
+      - Local and global metadata: 'core-abilities/metadata.md'
+      - RAG context enrichment: 'core-abilities/rag_context_enrichment.md'
+      - Self-reflection: 'core-abilities/self_reflection.md'
+      - Static code analysis: 'core-abilities/static_code_analysis.md'
   - Chrome Extension:
       - Qodo Merge Chrome Extension: 'chrome-extension/index.md'
       - Features: 'chrome-extension/features.md'