From fdd91c66631aa340b5a0a68625e63af98fd9f807 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Sun, 3 Aug 2025 15:42:09 +0300 Subject: [PATCH] docs: add compliance tool to RAG context enrichment documentation and adjust image widths --- .../core-abilities/rag_context_enrichment.md | 23 ++++++++++++------- docs/docs/tools/compliance.md | 4 ++-- 2 files changed, 17 insertions(+), 10 deletions(-) diff --git a/docs/docs/core-abilities/rag_context_enrichment.md b/docs/docs/core-abilities/rag_context_enrichment.md index 0fc64620..3113bbd6 100644 --- a/docs/docs/core-abilities/rag_context_enrichment.md +++ b/docs/docs/core-abilities/rag_context_enrichment.md @@ -44,11 +44,18 @@ enable_rag=true RAG capability is exclusively available in the following tools: -=== "`/review`" - 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. +=== "`/ask`" + 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. - ![RAGed review tool](https://codium.ai/images/pr_agent/rag_review.png){width=640} + ![RAGed ask tool](https://codium.ai/images/pr_agent/rag_ask.png){width=640} + + +=== "`/compliance`" + The [`/compliance`](https://qodo-merge-docs.qodo.ai/tools/compliance/) tool offers the _Codebase Code Duplication Compliance_ section which contains feedback based on the RAG references. + This section highlights possible code duplication issues in the PR, providing developers with insights into potential code quality concerns. + + ![RAGed compliance tool](https://codium.ai/images/pr_agent/rag_compliance.png){width=640} === "`/implement`" 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. @@ -56,11 +63,11 @@ RAG capability is exclusively available in the following tools: ![RAGed implement tool](https://codium.ai/images/pr_agent/rag_implement.png){width=640} -=== "`/ask`" - 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. +=== "`/review`" + 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. - ![RAGed ask tool](https://codium.ai/images/pr_agent/rag_ask.png){width=640} + ![RAGed review tool](https://codium.ai/images/pr_agent/rag_review.png){width=640} ## Limitations diff --git a/docs/docs/tools/compliance.md b/docs/docs/tools/compliance.md index b4e43ba7..3c951dda 100644 --- a/docs/docs/tools/compliance.md +++ b/docs/docs/tools/compliance.md @@ -5,10 +5,10 @@ The `compliance` tool performs comprehensive compliance checks on PR code changes, validating them against security standards, ticket requirements, and custom organizational compliance checklists, thereby helping teams, enterprises, and agents maintain consistent code quality and security practices while ensuring that development work aligns with business requirements. === "Fully Compliant" - ![compliance_overview](https://codium.ai/images/pr_agent/compliance_full.png){width=256} + ![compliance_overview](https://codium.ai/images/pr_agent/compliance_full.png){width=512} === "Partially Compliant" - ![compliance_overview](https://codium.ai/images/pr_agent/compliance_partial.png){width=256} + ![compliance_overview](https://codium.ai/images/pr_agent/compliance_partial.png){width=512} ___