From 4e466c07f93c3f7f19edad43fc9a4a9e64a5a4e6 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Sun, 15 Jun 2025 09:17:11 +0300 Subject: [PATCH] docs: standardize core abilities documentation headers and platform support format --- docs/docs/core-abilities/auto_approval.md | 4 ++-- docs/docs/core-abilities/code_validation.md | 5 +++++ docs/docs/core-abilities/compression_strategy.md | 5 ++++- docs/docs/core-abilities/dynamic_context.md | 3 ++- docs/docs/core-abilities/impact_evaluation.md | 4 +++- docs/docs/core-abilities/interactivity.md | 2 +- docs/docs/core-abilities/metadata.md | 4 +++- docs/docs/core-abilities/self_reflection.md | 2 +- docs/docs/core-abilities/static_code_analysis.md | 5 ++++- 9 files changed, 25 insertions(+), 9 deletions(-) diff --git a/docs/docs/core-abilities/auto_approval.md b/docs/docs/core-abilities/auto_approval.md index 9dffb134..64a0a2ae 100644 --- a/docs/docs/core-abilities/auto_approval.md +++ b/docs/docs/core-abilities/auto_approval.md @@ -1,6 +1,6 @@ +# Auto-approval 💎 - -> `💎 feature. Platforms supported: GitHub, GitLab, Bitbucket` +`Supported Git Platforms: GitHub, GitLab, Bitbucket` Under specific conditions, Qodo Merge can auto-approve a PR when a manual comment is invoked, or when the PR meets certain criteria. diff --git a/docs/docs/core-abilities/code_validation.md b/docs/docs/core-abilities/code_validation.md index 59e02eba..29cd4d05 100644 --- a/docs/docs/core-abilities/code_validation.md +++ b/docs/docs/core-abilities/code_validation.md @@ -1,3 +1,8 @@ +# Code Validation 💎 + +`Supported Git Platforms: GitHub, GitLab, Bitbucket` + + ## Introduction The Git environment usually represents the final stage before code enters production. Hence, Detecting bugs and issues during the review process is critical. diff --git a/docs/docs/core-abilities/compression_strategy.md b/docs/docs/core-abilities/compression_strategy.md index ff948b73..a4448f0e 100644 --- a/docs/docs/core-abilities/compression_strategy.md +++ b/docs/docs/core-abilities/compression_strategy.md @@ -1,5 +1,8 @@ -## Overview - PR Compression Strategy +`Supported Git Platforms: GitHub, GitLab, Bitbucket` + + +## Overview There are two scenarios: diff --git a/docs/docs/core-abilities/dynamic_context.md b/docs/docs/core-abilities/dynamic_context.md index 76ec2d6e..a68e7388 100644 --- a/docs/docs/core-abilities/dynamic_context.md +++ b/docs/docs/core-abilities/dynamic_context.md @@ -1,4 +1,5 @@ -## TL;DR + +`Supported Git Platforms: GitHub, GitLab, Bitbucket` Qodo Merge uses an **asymmetric and dynamic context strategy** to improve AI analysis of code changes in pull requests. It provides more context before changes than after, and dynamically adjusts the context based on code structure (e.g., enclosing functions or classes). diff --git a/docs/docs/core-abilities/impact_evaluation.md b/docs/docs/core-abilities/impact_evaluation.md index 4f56ea56..f76b8e5b 100644 --- a/docs/docs/core-abilities/impact_evaluation.md +++ b/docs/docs/core-abilities/impact_evaluation.md @@ -1,4 +1,6 @@ -# Overview - Impact Evaluation 💎 +# Impact Evaluation 💎 + +`Supported Git Platforms: GitHub, GitLab, Bitbucket` Demonstrating the return on investment (ROI) of AI-powered initiatives is crucial for modern organizations. To address this need, Qodo Merge has developed an AI impact measurement tools and metrics, providing advanced analytics to help businesses quantify the tangible benefits of AI adoption in their PR review process. diff --git a/docs/docs/core-abilities/interactivity.md b/docs/docs/core-abilities/interactivity.md index 04297b9e..8025093c 100644 --- a/docs/docs/core-abilities/interactivity.md +++ b/docs/docs/core-abilities/interactivity.md @@ -1,4 +1,4 @@ -# Interactivity +# Interactivity 💎 `Supported Git Platforms: GitHub, GitLab` diff --git a/docs/docs/core-abilities/metadata.md b/docs/docs/core-abilities/metadata.md index 00ed3b52..b5f49967 100644 --- a/docs/docs/core-abilities/metadata.md +++ b/docs/docs/core-abilities/metadata.md @@ -1,4 +1,6 @@ -## Local and global metadata injection with multi-stage analysis +# Local and global metadata injection with multi-stage analysis + +`Supported Git Platforms: GitHub, GitLab, Bitbucket` 1\. Qodo Merge initially retrieves for each PR the following data: diff --git a/docs/docs/core-abilities/self_reflection.md b/docs/docs/core-abilities/self_reflection.md index 2675a89d..e10c5f8b 100644 --- a/docs/docs/core-abilities/self_reflection.md +++ b/docs/docs/core-abilities/self_reflection.md @@ -1,4 +1,4 @@ -## TL;DR +`Supported Git Platforms: GitHub, GitLab, Bitbucket` Qodo Merge implements a **self-reflection** process where the AI model reflects, scores, and re-ranks its own suggestions, eliminating irrelevant or incorrect ones. This approach improves the quality and relevance of suggestions, saving users time and enhancing their experience. diff --git a/docs/docs/core-abilities/static_code_analysis.md b/docs/docs/core-abilities/static_code_analysis.md index 10eb2657..7117a560 100644 --- a/docs/docs/core-abilities/static_code_analysis.md +++ b/docs/docs/core-abilities/static_code_analysis.md @@ -1,4 +1,7 @@ -## Overview - Static Code Analysis 💎 +# Static Code Analysis 💎 + +` Supported Git Platforms: GitHub, GitLab, Bitbucket` + By combining static code analysis with LLM capabilities, Qodo Merge can provide a comprehensive analysis of the PR code changes on a component level.