From 630712e24c3d30d45e7f2696f12af1740835ea8e Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Tue, 1 Jul 2025 15:37:13 +0300 Subject: [PATCH 1/4] docs: update section headings and improve feature descriptions --- README.md | 8 ++++---- docs/docs/index.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0ee113a8..a1e38f8a 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ PR-Agent aims to help efficiently review and handle pull requests, by providing - [Getting Started](#getting-started) - [News and Updates](#news-and-updates) -- [Overview](#overview) +- [Features](#Features) - [See It in Action](#see-it-in-action) - [Try It Now](#try-it-now) - [Qodo Merge 💎](#qodo-merge-) @@ -60,7 +60,7 @@ Run PR-Agent locally on your repository via command line: [Local CLI setup guide ### Qodo Merge as post-commit in your local IDE See [here](https://github.com/qodo-ai/agents/tree/main/agents/qodo-merge-post-commit) -### Discover Qodo Merge 💎 +### Discover Qodo Merge 💎 Zero-setup hosted solution with advanced features and priority support - [Intro and Installation guide](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/) - [Plans & Pricing](https://www.qodo.ai/pricing/) @@ -101,11 +101,11 @@ New tool for Qodo Merge 💎 - `/scan_repo_discussions`. Read more about it [here](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/). -## Overview +## Features
-Supported commands per platform: +PR-Agent and Qodo Merge offer comprehensive pull request functionalities integrated with various git providers: | | | GitHub | GitLab | Bitbucket | Azure DevOps | Gitea | |---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|:-----:| diff --git a/docs/docs/index.md b/docs/docs/index.md index 46f49ff2..f67a8dbb 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -24,7 +24,7 @@ To search the documentation site using natural language: ## Features -PR-Agent and Qodo Merge offers extensive pull request functionalities across various git providers: +PR-Agent and Qodo Merge offer comprehensive pull request functionalities integrated with various git providers: | | | GitHub | GitLab | Bitbucket | Azure DevOps | Gitea | | ----- |---------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|:-----:| From 12d3d6cc0b24f30eab76060225d91bbf757a8fb3 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Tue, 1 Jul 2025 15:40:23 +0300 Subject: [PATCH 2/4] docs: move "Why Use PR-Agent?" section earlier in README --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a1e38f8a..4dec90a8 100644 --- a/README.md +++ b/README.md @@ -31,12 +31,12 @@ PR-Agent aims to help efficiently review and handle pull requests, by providing - [Getting Started](#getting-started) - [News and Updates](#news-and-updates) +- [Why Use PR-Agent?](#why-use-pr-agent) - [Features](#Features) - [See It in Action](#see-it-in-action) - [Try It Now](#try-it-now) - [Qodo Merge 💎](#qodo-merge-) - [How It Works](#how-it-works) -- [Why Use PR-Agent?](#why-use-pr-agent) - [Data Privacy](#data-privacy) - [Contributing](#contributing) - [Links](#links) @@ -101,6 +101,17 @@ New tool for Qodo Merge 💎 - `/scan_repo_discussions`. Read more about it [here](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/). +## Why Use PR-Agent? + +A reasonable question that can be asked is: `"Why use PR-Agent? What makes it stand out from existing tools?"` + +Here are some advantages of PR-Agent: + +- We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single LLM call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably. +- Our [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) is a core ability that enables to effectively tackle both short and long PRs. +- Our JSON prompting strategy enables us to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the [configuration](pr_agent/settings/configuration.toml) file. Adding additional categories is easy and accessible. +- We support **multiple git providers** (GitHub, GitLab, BitBucket), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT, Claude, Deepseek, ...) + ## Features
@@ -227,17 +238,6 @@ The following diagram illustrates PR-Agent tools and their flow: Check out the [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) page for more details on how we convert a code diff to a manageable LLM prompt -## Why Use PR-Agent? - -A reasonable question that can be asked is: `"Why use PR-Agent? What makes it stand out from existing tools?"` - -Here are some advantages of PR-Agent: - -- We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single LLM call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably. -- Our [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) is a core ability that enables to effectively tackle both short and long PRs. -- Our JSON prompting strategy enables us to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the [configuration](pr_agent/settings/configuration.toml) file. Adding additional categories is easy and accessible. -- We support **multiple git providers** (GitHub, GitLab, BitBucket), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT, Claude, Deepseek, ...) - ## Data Privacy ### Self-hosted PR-Agent From 2276caba3917668cb27a1eb8aaad2aaf676300f0 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Tue, 1 Jul 2025 15:49:28 +0300 Subject: [PATCH 3/4] docs: add FREE for Open Source link to Qodo Merge section --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 4dec90a8..3cd7af3c 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,7 @@ See [here](https://github.com/qodo-ai/agents/tree/main/agents/qodo-merge-post-co ### Discover Qodo Merge 💎 Zero-setup hosted solution with advanced features and priority support +- **[FREE for Open Source](https://github.com/marketplace/qodo-merge-pro-for-open-source)**: Full features, zero cost for public repos - [Intro and Installation guide](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/) - [Plans & Pricing](https://www.qodo.ai/pricing/) From d77d2f86da4a7542bd97c8017aa955b277e726c4 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Tue, 1 Jul 2025 15:54:37 +0300 Subject: [PATCH 4/4] docs: fix capitalization in Features section link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3cd7af3c..a4cacda2 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ PR-Agent aims to help efficiently review and handle pull requests, by providing - [Getting Started](#getting-started) - [News and Updates](#news-and-updates) - [Why Use PR-Agent?](#why-use-pr-agent) -- [Features](#Features) +- [Features](#features) - [See It in Action](#see-it-in-action) - [Try It Now](#try-it-now) - [Qodo Merge 💎](#qodo-merge-)