diff --git a/docs/docs/core-abilities/index.md b/docs/docs/core-abilities/index.md index ba431bc4..7a97a416 100644 --- a/docs/docs/core-abilities/index.md +++ b/docs/docs/core-abilities/index.md @@ -9,7 +9,7 @@ Qodo Merge utilizes a variety of core abilities to provide a comprehensive and e - [Impact evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) - [Interactivity](https://qodo-merge-docs.qodo.ai/core-abilities/interactivity/) - [Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) -- [Company Codebase](https://qodo-merge-docs.qodo.ai/core-abilities/company_codebase/) +- [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/) - [Code fine-tuning benchmark](https://qodo-merge-docs.qodo.ai/finetuning_benchmark/) diff --git a/docs/docs/core-abilities/company_codebase.md b/docs/docs/core-abilities/rag_context_enrichment.md similarity index 52% rename from docs/docs/core-abilities/company_codebase.md rename to docs/docs/core-abilities/rag_context_enrichment.md index d22e05e1..2ac6056a 100644 --- a/docs/docs/core-abilities/company_codebase.md +++ b/docs/docs/core-abilities/rag_context_enrichment.md @@ -1,17 +1,16 @@ -# Company Codebase 💎 -`Supported Git Platforms: GitHub` +# RAG Context Enrichment 💎 +`Supported Git Platforms: GitHub` ## Overview -### What is Company Codebase? +### What is RAG Context Enrichment? -An organized, semantic database that aggregates all your company’s source code into one searchable repository, enabling efficient code discovery and analysis. +A feature that enhances AI analysis by retrieving and referencing relevant code patterns from your project, enabling context-aware insights during code reviews. -### How does Company Codebase work? - -By indexing your company's code and using Retrieval-Augmented Generation (RAG), it retrieves contextual code segments on demand, improving pull request (PR) insights and accelerating review accuracy. +### How does RAG Context Enrichment work? +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 @@ -23,7 +22,7 @@ By indexing your company's code and using Retrieval-Augmented Generation (RAG), In order to enable the RAG feature, add the following lines to your configuration file: ``` toml [rag_arguments] -enable_rag=true +enable_rag=true ``` !!! example "RAG Arguments Options" @@ -31,27 +30,27 @@ enable_rag=true - + - +
enable_ragIf set to true, codebase enrichment using RAG will be enabled. Default is false.If set to true, repository enrichment using RAG will be enabled. Default is false.
rag_repo_listA list of repositories that will be used by the semantic search for RAG. Use `['all']` to consider the entire codebase or a select list or repositories, for example: ['my-org/my-repo', ...]. Default: the repository from which the PR was opened.A list of repositories that will be used by the semantic search for RAG. Use `['all']` to consider the entire codebase or a select list of repositories, for example: ['my-org/my-repo', ...]. Default: the repository from which the PR was opened.
-References from the codebase will be shown in a collapsible bookmark, allowing you to easily access relevant code snippets: +References from the repository will be shown in a collapsible bookmark, allowing you to easily access relevant code snippets: -![References](https://codium.ai/images/pr_agent/company_codebase_references.png){width=640} +![References](https://codium.ai/images/pr_agent/code_context_enrichment_references.png){width=640} ## Limitations -### Querying the codebase presents significant challenges: +### Querying the codebase presents significant challenges - **Search Method**: RAG uses natural language queries to find semantically relevant code sections - **Result Quality**: No guarantee that RAG results will be useful for all queries -- **Scope Recommendation**: To reduce noise, avoid using the whole codebase; focus on PR repository instead +- **Scope Recommendation**: To reduce noise, focus on the PR repository rather than searching across multiple repositories -### This feature has several requirements and restrictions: +### This feature has several requirements and restrictions - **Codebase**: Must be properly indexed for search functionality - **Security**: Requires secure and private indexed codebase implementation - **Deployment**: Only available for Qodo Merge Enterprise plan using single tenant or on-premises setup diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index aa1a0758..eed3f0c8 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -49,7 +49,7 @@ nav: - Impact evaluation: 'core-abilities/impact_evaluation.md' - Interactivity: 'core-abilities/interactivity.md' - Compression strategy: 'core-abilities/compression_strategy.md' - - Company Codebase: 'core-abilities/company_codebase.md' + - RAG Context Enrichment: 'core-abilities/rag_context_enrichment.md' - Static code analysis: 'core-abilities/static_code_analysis.md' - Code Fine-tuning Benchmark: 'finetuning_benchmark/index.md' - Chrome Extension: