From c94aa58ae4f6c8ba88d1ec71d163a861c4ac14fd Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Tue, 25 Mar 2025 09:23:30 +0200 Subject: [PATCH 1/3] Fix typo in Qodo Merge models documentation --- docs/docs/usage-guide/qodo_merge_models.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/usage-guide/qodo_merge_models.md b/docs/docs/usage-guide/qodo_merge_models.md index 8a83dfe4..2c48dd0a 100644 --- a/docs/docs/usage-guide/qodo_merge_models.md +++ b/docs/docs/usage-guide/qodo_merge_models.md @@ -1,5 +1,5 @@ -The default models used by Qodo Merge (March 2025) is Claude Sonnet 3.7. +The default model used by Qodo Merge (March 2025) is Claude Sonnet 3.7. ### Selecting a Specific Model From b0ed5848210b347c14dcd2837906c5b483f678da Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Tue, 25 Mar 2025 12:27:36 +0200 Subject: [PATCH 2/3] Update company codebase documentation link and rename file --- .../docs/core-abilities/code_oriented_yaml.md | 2 - docs/docs/core-abilities/company_codebase.md | 53 +++++++++++++++++++ docs/docs/core-abilities/index.md | 2 +- docs/mkdocs.yml | 2 +- 4 files changed, 55 insertions(+), 4 deletions(-) delete mode 100644 docs/docs/core-abilities/code_oriented_yaml.md create mode 100644 docs/docs/core-abilities/company_codebase.md diff --git a/docs/docs/core-abilities/code_oriented_yaml.md b/docs/docs/core-abilities/code_oriented_yaml.md deleted file mode 100644 index e65f8366..00000000 --- a/docs/docs/core-abilities/code_oriented_yaml.md +++ /dev/null @@ -1,2 +0,0 @@ -## Overview -TBD diff --git a/docs/docs/core-abilities/company_codebase.md b/docs/docs/core-abilities/company_codebase.md new file mode 100644 index 00000000..480db288 --- /dev/null +++ b/docs/docs/core-abilities/company_codebase.md @@ -0,0 +1,53 @@ +# Company Codebase 💎 +`Supported Git Platforms: GitHub` + + +## Overview + +### What is Company Codebase? + +An organized, semantic database that aggregates all your company’s source code into one searchable repository, enabling efficient code discovery and analysis. + +### 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. + + +## Getting started + +!!! info "Prerequisites" + - Database setup and codebase indexing must be completed before proceeding. [Contact support](https://www.qodo.ai/contact/) for assistance. + +### Configuration options + +In order to enable the RAG feature, add the following lines to your configuration file: +``` +[rag_arguments] +enable_rag=true +``` + +!!! example "RAG Arguments Options" + + + + + + + + + + +
enable_ragIf set to true, codebase 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.
+ + +## Limitations + +### 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 + +### 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/docs/core-abilities/index.md b/docs/docs/core-abilities/index.md index be61cd4c..ba431bc4 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/) -- [Code-oriented YAML](https://qodo-merge-docs.qodo.ai/core-abilities/code_oriented_yaml/) +- [Company Codebase](https://qodo-merge-docs.qodo.ai/core-abilities/company_codebase/) - [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/mkdocs.yml b/docs/mkdocs.yml index 86a8b07d..aa1a0758 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' - - Code-oriented YAML: 'core-abilities/code_oriented_yaml.md' + - Company Codebase: 'core-abilities/company_codebase.md' - Static code analysis: 'core-abilities/static_code_analysis.md' - Code Fine-tuning Benchmark: 'finetuning_benchmark/index.md' - Chrome Extension: From d6f79f486aead730582300bbbf09f45e6f904181 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Tue, 25 Mar 2025 12:42:11 +0200 Subject: [PATCH 3/3] Update code block syntax highlighting in company_codebase documentation --- docs/docs/core-abilities/company_codebase.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/core-abilities/company_codebase.md b/docs/docs/core-abilities/company_codebase.md index 480db288..6a746e82 100644 --- a/docs/docs/core-abilities/company_codebase.md +++ b/docs/docs/core-abilities/company_codebase.md @@ -21,7 +21,7 @@ By indexing your company's code and using Retrieval-Augmented Generation (RAG), ### Configuration options In order to enable the RAG feature, add the following lines to your configuration file: -``` +``` toml [rag_arguments] enable_rag=true ```