Skip to content

Commit 85f7b99

Browse files
authored
Merge pull request #1648 from qodo-ai/of/add-rag-docs
Update Docs: Company Codebase Overview, RAG Integration & Configuration
2 parents 05ea699 + d6f79f4 commit 85f7b99

File tree

5 files changed

+56
-5
lines changed

5 files changed

+56
-5
lines changed

docs/docs/core-abilities/code_oriented_yaml.md

Lines changed: 0 additions & 2 deletions
This file was deleted.
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Company Codebase 💎
2+
`Supported Git Platforms: GitHub`
3+
4+
5+
## Overview
6+
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.
10+
11+
### How does Company Codebase work?
12+
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.
14+
15+
16+
## Getting started
17+
18+
!!! info "Prerequisites"
19+
- Database setup and codebase indexing must be completed before proceeding. [Contact support](https://www.qodo.ai/contact/) for assistance.
20+
21+
### Configuration options
22+
23+
In order to enable the RAG feature, add the following lines to your configuration file:
24+
``` toml
25+
[rag_arguments]
26+
enable_rag=true
27+
```
28+
29+
!!! example "RAG Arguments Options"
30+
31+
<table>
32+
<tr>
33+
<td><b>enable_rag</b></td>
34+
<td>If set to true, codebase enrichment using RAG will be enabled. Default is false.</td>
35+
</tr>
36+
<tr>
37+
<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>
39+
</tr>
40+
</table>
41+
42+
43+
## Limitations
44+
45+
### Querying the codebase presents significant challenges:
46+
- **Search Method**: RAG uses natural language queries to find semantically relevant code sections
47+
- **Result Quality**: No guarantee that RAG results will be useful for all queries
48+
- **Scope Recommendation**: To reduce noise, avoid using the whole codebase; focus on PR repository instead
49+
50+
### This feature has several requirements and restrictions:
51+
- **Codebase**: Must be properly indexed for search functionality
52+
- **Security**: Requires secure and private indexed codebase implementation
53+
- **Deployment**: Only available for Qodo Merge Enterprise plan using single tenant or on-premises setup

docs/docs/core-abilities/index.md

Lines changed: 1 addition & 1 deletion
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-
- [Code-oriented YAML](https://qodo-merge-docs.qodo.ai/core-abilities/code_oriented_yaml/)
12+
- [Company Codebase](https://qodo-merge-docs.qodo.ai/core-abilities/company_codebase/)
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

docs/docs/usage-guide/qodo_merge_models.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
The default models used by Qodo Merge (March 2025) is Claude Sonnet 3.7.
2+
The default model used by Qodo Merge (March 2025) is Claude Sonnet 3.7.
33

44
### Selecting a Specific Model
55

docs/mkdocs.yml

Lines changed: 1 addition & 1 deletion
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-
- Code-oriented YAML: 'core-abilities/code_oriented_yaml.md'
52+
- Company Codebase: 'core-abilities/company_codebase.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)