Skip to content

Commit 8513a1a

Browse files
authored
Merge pull request #1660 from qodo-ai/of/refine-rag-file
docs: Rename Company Codebase to RAG Context Enrichment
2 parents a7ab04b + 8f0df43 commit 8513a1a

File tree

4 files changed

+17
-17
lines changed

4 files changed

+17
-17
lines changed

docs/docs/core-abilities/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Qodo Merge utilizes a variety of core abilities to provide a comprehensive and e
99
- [Impact evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/)
1010
- [Interactivity](https://qodo-merge-docs.qodo.ai/core-abilities/interactivity/)
1111
- [Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/)
12-
- [Company Codebase](https://qodo-merge-docs.qodo.ai/core-abilities/company_codebase/)
12+
- [RAG Context Enrichment](https://qodo-merge-docs.qodo.ai/core-abilities/rag_context_enrichment/)
1313
- [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/)
1414
- [Code fine-tuning benchmark](https://qodo-merge-docs.qodo.ai/finetuning_benchmark/)
1515

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
1-
# Company Codebase 💎
2-
`Supported Git Platforms: GitHub`
1+
# RAG Context Enrichment 💎
32

3+
`Supported Git Platforms: GitHub`
44

55
## Overview
66

7-
### What is Company Codebase?
8-
9-
An organized, semantic database that aggregates all your company’s source code into one searchable repository, enabling efficient code discovery and analysis.
7+
### What is RAG Context Enrichment?
108

11-
### How does Company Codebase work?
9+
A feature that enhances AI analysis by retrieving and referencing relevant code patterns from your project, enabling context-aware insights during code reviews.
1210

13-
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.
11+
### How does RAG Context Enrichment work?
1412

13+
Using Retrieval-Augmented Generation (RAG), it searches your configured repositories for contextually relevant code segments, enriching pull request (PR) insights and accelerating review accuracy.
1514

1615
## Getting started
1716

@@ -23,35 +22,35 @@ By indexing your company's code and using Retrieval-Augmented Generation (RAG),
2322
In order to enable the RAG feature, add the following lines to your configuration file:
2423
``` toml
2524
[rag_arguments]
26-
enable_rag=true
25+
enable_rag=true
2726
```
2827

2928
!!! example "RAG Arguments Options"
3029

3130
<table>
3231
<tr>
3332
<td><b>enable_rag</b></td>
34-
<td>If set to true, codebase enrichment using RAG will be enabled. Default is false.</td>
33+
<td>If set to true, repository enrichment using RAG will be enabled. Default is false.</td>
3534
</tr>
3635
<tr>
3736
<td><b>rag_repo_list</b></td>
38-
<td>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 or repositories, for example: ['my-org/my-repo', ...]. Default: the repository from which the PR was opened.</td>
37+
<td>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.</td>
3938
</tr>
4039
</table>
4140

4241

43-
References from the codebase will be shown in a collapsible bookmark, allowing you to easily access relevant code snippets:
42+
References from the repository will be shown in a collapsible bookmark, allowing you to easily access relevant code snippets:
4443

45-
![References](https://codium.ai/images/pr_agent/company_codebase_references.png){width=640}
44+
![References](https://codium.ai/images/pr_agent/rag_context_enrichment_references.png){width=640}
4645

4746
## Limitations
4847

49-
### Querying the codebase presents significant challenges:
48+
### Querying the codebase presents significant challenges
5049
- **Search Method**: RAG uses natural language queries to find semantically relevant code sections
5150
- **Result Quality**: No guarantee that RAG results will be useful for all queries
52-
- **Scope Recommendation**: To reduce noise, avoid using the whole codebase; focus on PR repository instead
51+
- **Scope Recommendation**: To reduce noise, focus on the PR repository rather than searching across multiple repositories
5352

54-
### This feature has several requirements and restrictions:
53+
### This feature has several requirements and restrictions
5554
- **Codebase**: Must be properly indexed for search functionality
5655
- **Security**: Requires secure and private indexed codebase implementation
5756
- **Deployment**: Only available for Qodo Merge Enterprise plan using single tenant or on-premises setup

docs/docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Qodo Merge is a hosted version of PR-Agent, designed for companies and teams tha
99

1010
- See the [Tools Guide](./tools/index.md) for a detailed description of the different tools.
1111

12+
- See the [Video Tutorials](https://www.youtube.com/playlist?list=PLRTpyDOSgbwFMA_VBeKMnPLaaZKwjGBFT) for practical demonstrations on how to use the tools.
1213

1314
## Docs Smart Search
1415

docs/mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ nav:
4949
- Impact evaluation: 'core-abilities/impact_evaluation.md'
5050
- Interactivity: 'core-abilities/interactivity.md'
5151
- Compression strategy: 'core-abilities/compression_strategy.md'
52-
- Company Codebase: 'core-abilities/company_codebase.md'
52+
- RAG Context Enrichment: 'core-abilities/rag_context_enrichment.md'
5353
- Static code analysis: 'core-abilities/static_code_analysis.md'
5454
- Code Fine-tuning Benchmark: 'finetuning_benchmark/index.md'
5555
- Chrome Extension:

0 commit comments

Comments
 (0)