From e571841b5c895922b10b9836f6bd1b4a314e899d Mon Sep 17 00:00:00 2001 From: mrT23 Date: Wed, 22 Jan 2025 21:11:46 +0200 Subject: [PATCH 1/3] docs: clarify distinction between PR-Agent and Qodo Merge throughout documentation --- docs/docs/chrome-extension/features.md | 2 +- docs/docs/faq/index.md | 4 +- docs/docs/index.md | 77 ++++++------ docs/docs/installation/index.md | 12 +- docs/docs/installation/locally.md | 125 ++++++++++--------- docs/docs/overview/data_privacy.md | 10 +- docs/docs/overview/index.md | 95 -------------- docs/docs/overview/pr_agent_pro.md | 10 +- docs/docs/tools/help.md | 2 +- docs/docs/tools/improve.md | 4 +- docs/docs/tools/index.md | 2 +- docs/docs/usage-guide/PR_agent_pro_models.md | 4 +- docs/mkdocs.yml | 2 +- 13 files changed, 130 insertions(+), 219 deletions(-) delete mode 100644 docs/docs/overview/index.md diff --git a/docs/docs/chrome-extension/features.md b/docs/docs/chrome-extension/features.md index 7edcbed1..cb0d78ec 100644 --- a/docs/docs/chrome-extension/features.md +++ b/docs/docs/chrome-extension/features.md @@ -8,7 +8,7 @@ To enable private chat, simply install the Qodo Merge Chrome extension. After in This chat session is **private**, and won't be visible to other users. All open-source repositories are supported. -For private repositories, you will also need to install Qodo Merge Pro, After installation, make sure to open at least one new PR to fully register your organization. Once done, you can chat with both new and existing PRs across all installed repositories. +For private repositories, you will also need to install Qodo Merge, After installation, make sure to open at least one new PR to fully register your organization. Once done, you can chat with both new and existing PRs across all installed repositories. #### Context-aware PR chat diff --git a/docs/docs/faq/index.md b/docs/docs/faq/index.md index 66f89c48..df5ed710 100644 --- a/docs/docs/faq/index.md +++ b/docs/docs/faq/index.md @@ -61,11 +61,11 @@ ___ When you self-host the [open-source](https://github.com/Codium-ai/pr-agent) version, you use your own keys. - Qodo Merge Pro with SaaS deployment is a hosted version of Qodo Merge, where Qodo manages the infrastructure and the keys. + Qodo Merge with SaaS deployment is a hosted version of Qodo Merge, where Qodo manages the infrastructure and the keys. For enterprise customers, on-prem deployment is also available. [Contact us](https://www.codium.ai/contact/#pricing) for more information. ___ -??? note "Q: Can Qodo Merge review draft/offline PRs?" +??? note "Q: Can Qodo Merge review draft/offline PRs?" #### Answer:5 Yes. While Qodo Merge won't automatically review draft PRs, you can still get feedback by manually requesting it through [online commenting](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#online-usage). diff --git a/docs/docs/index.md b/docs/docs/index.md index 7620accd..da2d3ab6 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -1,15 +1,16 @@ # Overview -Qodo Merge is an open-source tool to help efficiently review and handle pull requests. +PR-Agent is an open-source tool to help efficiently review and handle pull requests. +Qodo Merge is a hosted version of PR-Agent, designed for companies and teams that require additional features and capabilities - See the [Installation Guide](./installation/index.md) for instructions on installing and running the tool on different git platforms. -- See the [Usage Guide](./usage-guide/index.md) for instructions on running the Qodo Merge commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. +- See the [Usage Guide](./usage-guide/index.md) for instructions on running commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. - See the [Tools Guide](./tools/index.md) for a detailed description of the different tools. -## Qodo Merge Docs Smart Search +## Docs Smart Search To search the documentation site using natural language: @@ -25,44 +26,38 @@ To search the documentation site using natural language: Qodo Merge offers extensive pull request functionalities across various git providers. -| | | GitHub | GitLab | Bitbucket | Azure DevOps | -|-------|---------------------------------------------------------------------------------------------------------|:--------------------:|:--------------------:|:--------------------:|:------------:| -| TOOLS | [Review](https://qodo-merge-docs.qodo.ai/tools/review/) | ✅ | ✅ | ✅ | ✅ | -| | [Describe](https://qodo-merge-docs.qodo.ai/tools/describe/) | ✅ | ✅ | ✅ | ✅ | -| | [Improve](https://qodo-merge-docs.qodo.ai/tools/improve/) | ✅ | ✅ | ✅ | ✅ | -| | [Ask](https://qodo-merge-docs.qodo.ai/tools/ask/) | ✅ | ✅ | ✅ | ✅ | -| | ⮑ [Ask on code lines](https://pr-agent-docs.codium.ai/tools/ask#ask-lines) | ✅ | ✅ | | | -| | [Update CHANGELOG](https://qodo-merge-docs.qodo.ai/tools/update_changelog/) | ✅ | ✅ | ✅ | ✅ | -| | [Ticket Context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/) 💎 | ✅ | ✅ | ✅ | | -| | [Utilizing Best Practices](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) 💎 | ✅ | ✅ | ✅ | | -| | [PR Chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) 💎 | ✅ | | | | -| | [Suggestion Tracking](https://qodo-merge-docs.qodo.ai/tools/improve/#suggestion-tracking) 💎 | ✅ | ✅ | | | -| | [CI Feedback](https://pr-agent-docs.codium.ai/tools/ci_feedback/) 💎 | ✅ | | | | -| | [PR Documentation](https://pr-agent-docs.codium.ai/tools/documentation/) 💎 | ✅ | ✅ | | | -| | [Custom Labels](https://pr-agent-docs.codium.ai/tools/custom_labels/) 💎 | ✅ | ✅ | | | -| | [Analyze](https://pr-agent-docs.codium.ai/tools/analyze/) 💎 | ✅ | ✅ | | | -| | [Similar Code](https://pr-agent-docs.codium.ai/tools/similar_code/) 💎 | ✅ | | | | -| | [Custom Prompt](https://pr-agent-docs.codium.ai/tools/custom_prompt/) 💎 | ✅ | ✅ | ✅ | | -| | [Test](https://pr-agent-docs.codium.ai/tools/test/) 💎 | ✅ | ✅ | | | -| | [Implement](https://pr-agent-docs.codium.ai/tools/implement/) 💎 | ✅ | ✅ | ✅ | | -| | | | | | | -| USAGE | [CLI](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#local-repo-cli) | ✅ | ✅ | ✅ | ✅ | -| | [App / webhook](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#github-app) | ✅ | ✅ | ✅ | ✅ | -| | [Tagging bot](https://github.com/Codium-ai/pr-agent#try-it-now) | ✅ | | | | -| | [Actions](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action) | ✅ |✅| ✅ |✅| -| | | | | | | -| CORE | [PR compression](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) | ✅ | ✅ | ✅ | ✅ | -| | Adaptive and token-aware file patch fitting | ✅ | ✅ | ✅ | ✅ | -| | [Multiple models support](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/) | ✅ | ✅ | ✅ | ✅ | -| | [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/) | ✅ | ✅ | ✅ | ✅ | -| | [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/) | ✅ | ✅ | ✅ | ✅ | -| | [Self reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/) | ✅ | ✅ | ✅ | ✅ | -| | [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/) 💎 | ✅ | ✅ | ✅ | | -| | [Global and wiki configurations](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/) 💎 | ✅ | ✅ | ✅ | | -| | [PR interactive actions](https://www.codium.ai/images/pr_agent/pr-actions.mp4) 💎 | ✅ | ✅ | | | -| | [Impact Evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) 💎 | ✅ | ✅ | | | +| | | GitHub | Gitlab | Bitbucket | Azure DevOps | +|-------|-----------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:| +| TOOLS | Review | ✅ | ✅ | ✅ | ✅ | +| | ⮑ Incremental | ✅ | | | | +| | Ask | ✅ | ✅ | ✅ | ✅ | +| | Describe | ✅ | ✅ | ✅ | ✅ | +| | ⮑ [Inline file summary](https://qodo-merge-docs.qodo.ai/tools/describe/#inline-file-summary){:target="_blank"} 💎 | ✅ | ✅ | | ✅ | +| | Improve | ✅ | ✅ | ✅ | ✅ | +| | ⮑ Extended | ✅ | ✅ | ✅ | ✅ | +| | [Custom Prompt](./tools/custom_prompt.md){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ | +| | Reflect and Review | ✅ | ✅ | ✅ | ✅ | +| | Update CHANGELOG.md | ✅ | ✅ | ✅ | ️ | +| | Find Similar Issue | ✅ | | | ️ | +| | [Add PR Documentation](./tools/documentation.md){:target="_blank"} 💎 | ✅ | ✅ | | ✅ | +| | [Generate Custom Labels](./tools/describe.md#handle-custom-labels-from-the-repos-labels-page-💎){:target="_blank"} 💎 | ✅ | ✅ | | ✅ | +| | [Analyze PR Components](./tools/analyze.md){:target="_blank"} 💎 | ✅ | ✅ | | ✅ | +| | [Test](https://pr-agent-docs.codium.ai/tools/test/) 💎 | ✅ | ✅ | | | +| | [Implement](https://pr-agent-docs.codium.ai/tools/implement/) 💎 | ✅ | ✅ | ✅ | | +| | | | | | ️ | +| USAGE | CLI | ✅ | ✅ | ✅ | ✅ | +| | App / webhook | ✅ | ✅ | ✅ | ✅ | +| | Actions | ✅ | | | ️ | +| | | | | | +| CORE | PR compression | ✅ | ✅ | ✅ | ✅ | +| | Repo language prioritization | ✅ | ✅ | ✅ | ✅ | +| | Adaptive and token-aware file patch fitting | ✅ | ✅ | ✅ | ✅ | +| | Multiple models support | ✅ | ✅ | ✅ | ✅ | +| | Incremental PR review | ✅ | | | | +| | [Static code analysis](./tools/analyze.md/){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ | +| | [Multiple configuration options](./usage-guide/configuration_options.md){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ | -💎 marks a feature available only in [Qodo Merge Pro](https://www.qodo.ai/pricing/){:target="_blank"} +💎 marks a feature available only in [Qodo Merge](https://www.codium.ai/pricing/){:target="_blank"}, and not in the open-source version. ## Example Results @@ -98,4 +93,4 @@ The following diagram illustrates Qodo Merge tools and their flow: ![Qodo Merge Tools](https://codium.ai/images/pr_agent/diagram-v0.9.png) -Check out the [core abilities](core-abilities/index.md) page for a comprehensive overview of the variety of core abilities used by Qodo Merge. +Check out the [PR Compression strategy](core-abilities/index.md) page for more details on how we convert a code diff to a manageable LLM prompt diff --git a/docs/docs/installation/index.md b/docs/docs/installation/index.md index 1fe94f50..b5956936 100644 --- a/docs/docs/installation/index.md +++ b/docs/docs/installation/index.md @@ -1,12 +1,12 @@ # Installation -## Self-hosted Qodo Merge -If you choose to host your own Qodo Merge, you first need to acquire two tokens: +## Self-hosted PR-Agent +If you choose to host your own PR-Agent, you first need to acquire two tokens: 1. An OpenAI key from [here](https://platform.openai.com/api-keys){:target="_blank"}, with access to GPT-4 (or a key for other [language models](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/), if you prefer). 2. A GitHub\GitLab\BitBucket personal access token (classic), with the repo scope. [GitHub from [here](https://github.com/settings/tokens){:target="_blank"}] -There are several ways to use self-hosted Qodo Merge: +There are several ways to use self-hosted PR-Agent: - [Locally](./locally.md) - [GitHub](./github.md) @@ -14,8 +14,8 @@ There are several ways to use self-hosted Qodo Merge: - [BitBucket](./bitbucket.md) - [Azure DevOps](./azure.md) -## Qodo Merge Pro 💎 -Qodo Merge Pro, an app hosted by CodiumAI for GitHub\GitLab\BitBucket, is also available. +## Qodo Merge 💎 +Qodo Merge, an app hosted by QodoAI for GitHub\GitLab\BitBucket, is also available.
-With Qodo Merge Pro, installation is as simple as signing up and adding the Qodo Merge app to your relevant repo. +With Qodo Merge, installation is as simple as signing up and adding the Qodo Merge app to your relevant repo. See [here](https://qodo-merge-docs.qodo.ai/installation/pr_agent_pro/) for more details. diff --git a/docs/docs/installation/locally.md b/docs/docs/installation/locally.md index 8ed53c4c..ee82253b 100644 --- a/docs/docs/installation/locally.md +++ b/docs/docs/installation/locally.md @@ -1,3 +1,71 @@ +## Using Docker image + +A list of the relevant tools can be found in the [tools guide](../tools/ask.md). + +To invoke a tool (for example `review`), you can run directly from the Docker image. Here's how: + +- For GitHub: + ``` + docker run --rm -it -e OPENAI.KEY= -e GITHUB.USER_TOKEN= codiumai/pr-agent:latest --pr_url review + ``` + If you are using GitHub enterprise server, you need to specify the custom url as variable. + For example, if your GitHub server is at `https://github.mycompany.com`, add the following to the command: + ``` + -e GITHUB.BASE_URL=https://github.mycompany.com/api/v3 + ``` + +- For GitLab: + ``` + docker run --rm -it -e OPENAI.KEY= -e CONFIG.GIT_PROVIDER=gitlab -e GITLAB.PERSONAL_ACCESS_TOKEN= codiumai/pr-agent:latest --pr_url review + ``` + + If you have a dedicated GitLab instance, you need to specify the custom url as variable: + ``` + -e GITLAB.URL= + ``` + +- For BitBucket: + ``` + docker run --rm -it -e CONFIG.GIT_PROVIDER=bitbucket -e OPENAI.KEY=$OPENAI_API_KEY -e BITBUCKET.BEARER_TOKEN=$BITBUCKET_BEARER_TOKEN codiumai/pr-agent:latest --pr_url= review + ``` + +For other git providers, update `CONFIG.GIT_PROVIDER` accordingly and check the [`pr_agent/settings/.secrets_template.toml`](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/.secrets_template.toml) file for environment variables expected names and values. + +### Utilizing environment variables + +It is also possible to provide or override the configuration by setting the corresponding environment variables. +You can define the corresponding environment variables by following this convention: `__=` or `
.=`. +The `
` refers to a table/section in a configuration file and `=` refers to the key/value pair of a setting in the configuration file. + +For example, suppose you want to run `pr_agent` that connects to a self-hosted GitLab instance similar to an example above. +You can define the environment variables in a plain text file named `.env` with the following content: + +``` +CONFIG__GIT_PROVIDER="gitlab" +GITLAB__URL="" +GITLAB__PERSONAL_ACCESS_TOKEN="" +OPENAI__KEY="" +``` + +Then, you can run `pr_agent` using Docker with the following command: + +```shell +docker run --rm -it --env-file .env codiumai/pr-agent:latest +``` + +--- + +### I get an error when running the Docker image. What should I do? + +If you encounter an error when running the Docker image, it is almost always due to a misconfiguration of api keys or tokens. + +Note that litellm, which is used by pr-agent, sometimes returns non-informative error messages such as `APIError: OpenAIException - Connection error.` +Carefully check the api keys and tokens you provided and make sure they are correct. +Adjustments may be needed depending on your llm provider. + +For example, for Azure OpenAI, additional keys are [needed](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/#azure). +Same goes for other providers, make sure to check the [documentation](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/#changing-a-model) + ## Using pip package Install the package: @@ -35,63 +103,6 @@ if __name__ == '__main__': main() ``` -## Using Docker image - -A list of the relevant tools can be found in the [tools guide](../tools/ask.md). - -To invoke a tool (for example `review`), you can run directly from the Docker image. Here's how: - -- For GitHub: - ``` - docker run --rm -it -e OPENAI.KEY= -e GITHUB.USER_TOKEN= codiumai/pr-agent:latest --pr_url review - ``` - If you are using GitHub enterprise server, you need to specify the custom url as variable. - For example, if your GitHub server is at `https://github.mycompany.com`, add the following to the command: - ``` - -e GITHUB.BASE_URL=https://github.mycompany.com/api/v3 - ``` - -- For GitLab: - ``` - docker run --rm -it -e OPENAI.KEY= -e CONFIG.GIT_PROVIDER=gitlab -e GITLAB.PERSONAL_ACCESS_TOKEN= codiumai/pr-agent:latest --pr_url review - ``` - - If you have a dedicated GitLab instance, you need to specify the custom url as variable: - ``` - -e GITLAB.URL= - ``` - -- For BitBucket: - ``` - docker run --rm -it -e CONFIG.GIT_PROVIDER=bitbucket -e OPENAI.KEY=$OPENAI_API_KEY -e BITBUCKET.BEARER_TOKEN=$BITBUCKET_BEARER_TOKEN codiumai/pr-agent:latest --pr_url= review - ``` - -For other git providers, update `CONFIG.GIT_PROVIDER` accordingly and check the `pr_agent/settings/.secrets_template.toml` file for environment variables expected names and values. -The `pr_agent` uses [Dynaconf](https://www.dynaconf.com/) to load settings from configuration files. - -It is also possible to provide or override the configuration by setting the corresponding environment variables. -You can define the corresponding environment variables by following this convention: `
__=` or `
.=`. -The `
` refers to a table/section in a configuration file and `=` refers to the key/value pair of a setting in the configuration file. - -For example, suppose you want to run `pr_agent` that connects to a self-hosted GitLab instance similar to an example above. -You can define the environment variables in a plain text file named `.env` with the following content: - -> Warning: Never commit the `.env` file to version control system as it might contains sensitive credentials! - -``` -CONFIG__GIT_PROVIDER="gitlab" -GITLAB__URL="" -GITLAB__PERSONAL_ACCESS_TOKEN="" -OPENAI__KEY="" -``` - -Then, you can run `pr_agent` using Docker with the following command: - -```shell -docker run --rm -it --env-file .env codiumai/pr-agent:latest -``` - ---- ## Run from source diff --git a/docs/docs/overview/data_privacy.md b/docs/docs/overview/data_privacy.md index 5cec7f32..4595661f 100644 --- a/docs/docs/overview/data_privacy.md +++ b/docs/docs/overview/data_privacy.md @@ -1,12 +1,12 @@ -## Self-hosted Qodo Merge +## Self-hosted PR-Agent -- If you self-host Qodo Merge with your OpenAI (or other LLM provider) API key, it is between you and the provider. We don't send your code data to Qodo Merge servers. +- If you self-host PR-Agent with your OpenAI (or other LLM provider) API key, it is between you and the provider. We don't send your code data to Qodo servers. -## Qodo Merge Pro 💎 +## Qodo Merge 💎 -- When using Qodo Merge Pro 💎, hosted by CodiumAI, we will not store any of your data, nor will we use it for training. You will also benefit from an OpenAI account with zero data retention. +- When using Qodo Merge💎, hosted by Qodo, we will not store any of your data, nor will we use it for training. You will also benefit from an OpenAI account with zero data retention. -- For certain clients, CodiumAI-hosted Qodo Merge Pro will use CodiumAI’s proprietary models. If this is the case, you will be notified. +- For certain clients, Qodo Merge will use Qodo’s proprietary models. If this is the case, you will be notified. - No passive collection of Code and Pull Requests’ data — Qodo Merge will be active only when you invoke it, and it will then extract and analyze only data relevant to the executed command and queried pull request. diff --git a/docs/docs/overview/index.md b/docs/docs/overview/index.md deleted file mode 100644 index 8bda4358..00000000 --- a/docs/docs/overview/index.md +++ /dev/null @@ -1,95 +0,0 @@ -# Overview - -Qodo Merge is an open-source tool to help efficiently review and handle pull requests. - -- See the [Installation Guide](./installation/index.md) for instructions on installing and running the tool on different git platforms. - -- See the [Usage Guide](./usage-guide/index.md) for instructions on running the Qodo Merge commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. - -- See the [Tools Guide](./tools/index.md) for a detailed description of the different tools. - - -## Qodo Merge Docs Smart Search - -To search the documentation site using natural language: - -1) Comment `/help "your question"` in either: - - - A pull request where Qodo Merge is installed - - A [PR Chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) - -2) Qodo Merge will respond with an [answer](https://github.com/Codium-ai/pr-agent/pull/1241#issuecomment-2365259334) that includes relevant documentation links. - - -## Qodo Merge Features - -Qodo Merge offers extensive pull request functionalities across various git providers. - -| | | GitHub | Gitlab | Bitbucket | Azure DevOps | -|-------|-----------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:| -| TOOLS | Review | ✅ | ✅ | ✅ | ✅ | -| | ⮑ Incremental | ✅ | | | | -| | Ask | ✅ | ✅ | ✅ | ✅ | -| | Describe | ✅ | ✅ | ✅ | ✅ | -| | ⮑ [Inline file summary](https://qodo-merge-docs.qodo.ai/tools/describe/#inline-file-summary){:target="_blank"} 💎 | ✅ | ✅ | | ✅ | -| | Improve | ✅ | ✅ | ✅ | ✅ | -| | ⮑ Extended | ✅ | ✅ | ✅ | ✅ | -| | [Custom Prompt](./tools/custom_prompt.md){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ | -| | Reflect and Review | ✅ | ✅ | ✅ | ✅ | -| | Update CHANGELOG.md | ✅ | ✅ | ✅ | ️ | -| | Find Similar Issue | ✅ | | | ️ | -| | [Add PR Documentation](./tools/documentation.md){:target="_blank"} 💎 | ✅ | ✅ | | ✅ | -| | [Generate Custom Labels](./tools/describe.md#handle-custom-labels-from-the-repos-labels-page-💎){:target="_blank"} 💎 | ✅ | ✅ | | ✅ | -| | [Analyze PR Components](./tools/analyze.md){:target="_blank"} 💎 | ✅ | ✅ | | ✅ | -| | [Test](https://pr-agent-docs.codium.ai/tools/test/) 💎 | ✅ | ✅ | | | -| | [Implement](https://pr-agent-docs.codium.ai/tools/implement/) 💎 | ✅ | ✅ | ✅ | | -| | | | | | ️ | -| USAGE | CLI | ✅ | ✅ | ✅ | ✅ | -| | App / webhook | ✅ | ✅ | ✅ | ✅ | -| | Actions | ✅ | | | ️ | -| | | | | | -| CORE | PR compression | ✅ | ✅ | ✅ | ✅ | -| | Repo language prioritization | ✅ | ✅ | ✅ | ✅ | -| | Adaptive and token-aware file patch fitting | ✅ | ✅ | ✅ | ✅ | -| | Multiple models support | ✅ | ✅ | ✅ | ✅ | -| | Incremental PR review | ✅ | | | | -| | [Static code analysis](./tools/analyze.md/){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ | -| | [Multiple configuration options](./usage-guide/configuration_options.md){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ | - -💎 marks a feature available only in [Qodo Merge Pro](https://www.codium.ai/pricing/){:target="_blank"} - - -## Example Results -
- -#### [/describe](https://github.com/Codium-ai/pr-agent/pull/530) -
-![/describe](https://www.codium.ai/images/pr_agent/describe_new_short_main.png){width=512} -
-
- -#### [/review](https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099151) -
-![/review](https://www.codium.ai/images/pr_agent/review_new_short_main.png){width=512} -
-
- -#### [/improve](https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099159) -
-![/improve](https://www.codium.ai/images/pr_agent/improve_new_short_main.png){width=512} -
-
- -#### [/generate_labels](https://github.com/Codium-ai/pr-agent/pull/530) -
-![/generate_labels](https://www.codium.ai/images/pr_agent/geneare_custom_labels_main_short.png){width=300} -
-
- -## How it Works - -The following diagram illustrates Qodo Merge tools and their flow: - -![Qodo Merge Tools](https://codium.ai/images/pr_agent/diagram-v0.9.png) - -Check out the [PR Compression strategy](core-abilities/index.md) page for more details on how we convert a code diff to a manageable LLM prompt diff --git a/docs/docs/overview/pr_agent_pro.md b/docs/docs/overview/pr_agent_pro.md index 80d78434..25a42ac8 100644 --- a/docs/docs/overview/pr_agent_pro.md +++ b/docs/docs/overview/pr_agent_pro.md @@ -1,17 +1,17 @@ ### Overview -[Qodo Merge Pro](https://www.codium.ai/pricing/){:target="_blank"} is a hosted version of open-source [Qodo Merge (PR-Agent)](https://github.com/Codium-ai/pr-agent){:target="_blank"}. A complimentary two-week trial is offered, followed by a monthly subscription fee. -Qodo Merge Pro is designed for companies and teams that require additional features and capabilities. It provides the following benefits: +[Qodo Merge](https://www.codium.ai/pricing/){:target="_blank"} is a hosted version of open-source [PR-Agent](https://github.com/Codium-ai/pr-agent){:target="_blank"}. A complimentary two-week trial is offered, followed by a monthly subscription fee. +Qodo Merge is designed for companies and teams that require additional features and capabilities. It provides the following benefits: 1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the Qodo Merge app to your GitHub\GitLab\BitBucket repo. 2. **Improved privacy** - No data will be stored or used to train models. Qodo Merge Pro will employ zero data retention, and will use an OpenAI and Claude accounts with zero data retention. -3. **Improved support** - Qodo Merge Pro users will receive priority support, and will be able to request new features and capabilities. +3. **Improved support** - Qodo Merge users will receive priority support, and will be able to request new features and capabilities. -4. **Supporting self-hosted git servers** - Qodo Merge Pro can be installed on GitHub Enterprise Server, GitLab, and BitBucket. For more information, see the [installation guide](https://qodo-merge-docs.qodo.ai/installation/pr_agent_pro/). +4. **Supporting self-hosted git servers** - Qodo Merge can be installed on GitHub Enterprise Server, GitLab, and BitBucket. For more information, see the [installation guide](https://qodo-merge-docs.qodo.ai/installation/pr_agent_pro/). -5. **PR Chat** - Qodo Merge Pro allows you to engage in [private chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) about your pull requests on private repositories. +5. **PR Chat** - Qodo Merge allows you to engage in [private chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) about your pull requests on private repositories. ### Additional features diff --git a/docs/docs/tools/help.md b/docs/docs/tools/help.md index ba68477f..aaf409f6 100644 --- a/docs/docs/tools/help.md +++ b/docs/docs/tools/help.md @@ -1,6 +1,6 @@ ## Overview The `help` tool provides a list of all the available tools and their descriptions. -For Qodo Merge Pro users, it also enables to trigger each tool by checking the relevant box. +For Qodo Merge users, it also enables to trigger each tool by checking the relevant box. It can be invoked manually by commenting on any PR: ``` diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index fd16a609..cfb312a7 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -9,7 +9,7 @@ The tool can be triggered automatically every time a new PR is [opened](../usage ![code_suggestions_as_comment_open.png](https://codium.ai/images/pr_agent/code_suggestions_as_comment_open.png){width=512} -Note that the `Apply this suggestion` checkbox, which interactively converts a suggestion into a commitable code comment, is available only for Qodo Merge Pro 💎 users. +Note that the `Apply this suggestion` checkbox, which interactively converts a suggestion into a commitable code comment, is available only for Qodo Merge💎 users. ## Example usage @@ -54,7 +54,7 @@ num_code_suggestions_per_chunk = ... ### Assessing Impact 💎 -Note that Qodo Merge pro tracks two types of implementations: +Note that Qodo Merge tracks two types of implementations: - Direct implementation - when the user directly applies the suggestion by clicking the `Apply` checkbox. - Indirect implementation - when the user implements the suggestion in their IDE environment. In this case, Qodo Merge will utilize, after each commit, a dedicated logic to identify if a suggestion was implemented, and will mark it as implemented. diff --git a/docs/docs/tools/index.md b/docs/docs/tools/index.md index 4736f62c..58af637f 100644 --- a/docs/docs/tools/index.md +++ b/docs/docs/tools/index.md @@ -20,4 +20,4 @@ Here is a list of Qodo Merge tools, each with a dedicated page that explains how | **💎 [Improve Component (`/improve_component component_name`](./improve_component.md))** | Generates code suggestions for a specific code component that changed in the PR | | **💎 [CI Feedback (`/checks ci_job`](./ci_feedback.md))** | Automatically generates feedback and analysis for a failed CI job | | **💎 [Implement (`/implement`](./implement.md))** | Generates implementation code from review suggestions | -Note that the tools marked with 💎 are available only for Qodo Merge Pro users. +Note that the tools marked with 💎 are available only for Qodo Merge users. diff --git a/docs/docs/usage-guide/PR_agent_pro_models.md b/docs/docs/usage-guide/PR_agent_pro_models.md index 367e1b9c..008252ce 100644 --- a/docs/docs/usage-guide/PR_agent_pro_models.md +++ b/docs/docs/usage-guide/PR_agent_pro_models.md @@ -1,4 +1,4 @@ -## Qodo Merge Pro Models +## Qodo Merge Models The default models used by Qodo Merge Pro are a combination of Claude-3.5-sonnet and OpenAI's GPT-4 models. @@ -11,7 +11,7 @@ For example, to restrict Qodo Merge Pro to using only `Claude-3.5-sonnet`, add t model="claude-3-5-sonnet" ``` -Or to restrict Qodo Merge Pro to using only `GPT-4o`, add this setting: +Or to restrict Qodo Merge to using only `GPT-4o`, add this setting: ``` [config] model="gpt-4o" diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 2a4717a7..96410556 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: Qodo Merge (formerly known as PR-Agent) +site_name: Qodo Merge (and open-source PR-Agent) repo_url: https://github.com/Codium-ai/pr-agent repo_name: Codium-ai/pr-agent From 983ce131f230868f3c84050e2f1b93e42227853f Mon Sep 17 00:00:00 2001 From: mrT23 Date: Wed, 22 Jan 2025 21:18:08 +0200 Subject: [PATCH 2/3] docs: rebrand from Qodo Merge Pro to Qodo Merge throughout documentation --- docs/docs/chrome-extension/data_privacy.md | 2 +- docs/docs/chrome-extension/index.md | 4 +-- docs/docs/index.md | 4 +-- docs/docs/installation/azure.md | 2 +- docs/docs/installation/bitbucket.md | 2 +- docs/docs/installation/pr_agent_pro.md | 26 +++++++++---------- docs/docs/overview/pr_agent_pro.md | 14 +++++----- docs/docs/tools/custom_labels.md | 2 +- docs/docs/usage-guide/PR_agent_pro_models.md | 6 ++--- .../docs/usage-guide/automations_and_usage.md | 4 +-- .../docs/usage-guide/configuration_options.md | 2 +- docs/docs/usage-guide/index.md | 2 +- docs/mkdocs.yml | 6 ++--- 13 files changed, 38 insertions(+), 38 deletions(-) diff --git a/docs/docs/chrome-extension/data_privacy.md b/docs/docs/chrome-extension/data_privacy.md index 848f8f2d..05a3a7e1 100644 --- a/docs/docs/chrome-extension/data_privacy.md +++ b/docs/docs/chrome-extension/data_privacy.md @@ -1,4 +1,4 @@ We take your code's security and privacy seriously: - The Chrome extension will not send your code to any external servers. -- For private repositories, we will first validate the user's identity and permissions. After authentication, we generate responses using the existing Qodo Merge Pro integration. +- For private repositories, we will first validate the user's identity and permissions. After authentication, we generate responses using the existing Qodo Merge integration. diff --git a/docs/docs/chrome-extension/index.md b/docs/docs/chrome-extension/index.md index b6eb1b05..b61f9776 100644 --- a/docs/docs/chrome-extension/index.md +++ b/docs/docs/chrome-extension/index.md @@ -4,8 +4,8 @@ With a single-click installation you will gain access to a context-aware chat on The extension is powered by top code models like Claude 3.5 Sonnet and GPT4. All the extension's features are free to use on public repositories. -For private repositories, you will need to install [Qodo Merge Pro](https://github.com/apps/qodo-merge-pro){:target="_blank"} in addition to the extension (Quick GitHub app setup with a 14-day free trial. No credit card needed). -For a demonstration of how to install Qodo Merge Pro and use it with the Chrome extension, please refer to the tutorial video at the provided [link](https://codium.ai/images/pr_agent/private_repos.mp4){:target="_blank"}. +For private repositories, you will need to install [Qodo Merge](https://github.com/apps/qodo-merge-pro){:target="_blank"} in addition to the extension (Quick GitHub app setup with a 14-day free trial. No credit card needed). +For a demonstration of how to install Qodo Merge and use it with the Chrome extension, please refer to the tutorial video at the provided [link](https://codium.ai/images/pr_agent/private_repos.mp4){:target="_blank"}. diff --git a/docs/docs/index.md b/docs/docs/index.md index da2d3ab6..e3700b23 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -1,6 +1,6 @@ # Overview -PR-Agent is an open-source tool to help efficiently review and handle pull requests. +[PR-Agent](https://github.com/Codium-ai/pr-agent) is an open-source tool to help efficiently review and handle pull requests. Qodo Merge is a hosted version of PR-Agent, designed for companies and teams that require additional features and capabilities - See the [Installation Guide](./installation/index.md) for instructions on installing and running the tool on different git platforms. @@ -19,7 +19,7 @@ To search the documentation site using natural language: - A pull request where Qodo Merge is installed - A [PR Chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) -2) Qodo Merge will respond with an [answer](https://github.com/Codium-ai/pr-agent/pull/1241#issuecomment-2365259334) that includes relevant documentation links. +2) The bot will respond with an [answer](https://github.com/Codium-ai/pr-agent/pull/1241#issuecomment-2365259334) that includes relevant documentation links. ## Qodo Merge Features diff --git a/docs/docs/installation/azure.md b/docs/docs/installation/azure.md index 134b7b4a..1d458f58 100644 --- a/docs/docs/installation/azure.md +++ b/docs/docs/installation/azure.md @@ -52,7 +52,7 @@ stages: This script will run Qodo Merge on every new merge request, with the `improve`, `review`, and `describe` commands. Note that you need to export the `azure_devops__pat` and `OPENAI_KEY` variables in the Azure DevOps pipeline settings (Pipelines -> Library -> + Variable group): -![Qodo Merge Pro](https://codium.ai/images/pr_agent/azure_devops_pipeline_secrets.png){width=468} +![Qodo Merge](https://codium.ai/images/pr_agent/azure_devops_pipeline_secrets.png){width=468} Make sure to give pipeline permissions to the `pr_agent` variable group. diff --git a/docs/docs/installation/bitbucket.md b/docs/docs/installation/bitbucket.md index 346c86f8..58978473 100644 --- a/docs/docs/installation/bitbucket.md +++ b/docs/docs/installation/bitbucket.md @@ -29,7 +29,7 @@ Note that comments on a PR are not supported in Bitbucket Pipeline. ## Run using CodiumAI-hosted Bitbucket app 💎 -Please contact visit [Qodo Merge Pro](https://www.codium.ai/pricing/) if you're interested in a hosted BitBucket app solution that provides full functionality including PR reviews and comment handling. It's based on the [bitbucket_app.py](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/git_providers/bitbucket_provider.py) implementation. +Please contact visit [Qodo Merge](https://www.codium.ai/pricing/) if you're interested in a hosted BitBucket app solution that provides full functionality including PR reviews and comment handling. It's based on the [bitbucket_app.py](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/git_providers/bitbucket_provider.py) implementation. ## Bitbucket Server and Data Center diff --git a/docs/docs/installation/pr_agent_pro.md b/docs/docs/installation/pr_agent_pro.md index 60889146..0e6a7f01 100644 --- a/docs/docs/installation/pr_agent_pro.md +++ b/docs/docs/installation/pr_agent_pro.md @@ -1,42 +1,42 @@ -Qodo Merge Pro is a versatile application compatible with GitHub, GitLab, and BitBucket, hosted by QodoAI. -See [here](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) for more details about the benefits of using Qodo Merge Pro. +Qodo Merge is a versatile application compatible with GitHub, GitLab, and BitBucket, hosted by QodoAI. +See [here](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) for more details about the benefits of using Qodo Merge. A complimentary two-week trial is provided to all new users. Following the trial period, user licenses (seats) are required for continued access. To purchase user licenses, please visit our [pricing page](https://www.qodo.ai/pricing/). Once subscribed, users can seamlessly deploy the application across any of their code repositories. -## Install Qodo Merge Pro for GitHub +## Install Qodo Merge for GitHub ### GitHub Cloud -Qodo Merge Pro for GitHub cloud is available for installation through the [GitHub Marketplace](https://github.com/apps/qodo-merge-pro). +Qodo Merge for GitHub cloud is available for installation through the [GitHub Marketplace](https://github.com/apps/qodo-merge-pro). -![Qodo Merge Pro](https://codium.ai/images/pr_agent/pr_agent_pro_install.png){width=468} +![Qodo Merge](https://codium.ai/images/pr_agent/pr_agent_pro_install.png){width=468} ### GitHub Enterprise Server -To use Qodo Merge Pro application on your private GitHub Enterprise Server, you will need to contact us for starting an [Enterprise](https://www.codium.ai/pricing/) trial. +To use Qodo Merge application on your private GitHub Enterprise Server, you will need to contact us for starting an [Enterprise](https://www.codium.ai/pricing/) trial. ### GitHub Open Source Projects -For open-source projects, Qodo Merge Pro is available for free usage. To install Qodo Merge Pro for your open-source repositories, use the following marketplace [link](https://github.com/apps/qodo-merge-pro-for-open-source). +For open-source projects, Qodo Merge is available for free usage. To install Qodo Merge for your open-source repositories, use the following marketplace [link](https://github.com/apps/qodo-merge-pro-for-open-source). -## Install Qodo Merge Pro for Bitbucket +## Install Qodo Merge for Bitbucket ### Bitbucket Cloud -Qodo Merge Pro for Bitbucket Cloud is available for installation through the following [link](https://bitbucket.org/site/addons/authorize?addon_key=d6df813252c37258) +Qodo Merge for Bitbucket Cloud is available for installation through the following [link](https://bitbucket.org/site/addons/authorize?addon_key=d6df813252c37258) -![Qodo Merge Pro](https://qodo.ai/images/pr_agent/pr_agent_pro_bitbucket_install.png){width=468} +![Qodo Merge](https://qodo.ai/images/pr_agent/pr_agent_pro_bitbucket_install.png){width=468} ### Bitbucket Server -To use Qodo Merge Pro application on your private Bitbucket Server, you will need to contact us for starting an [Enterprise](https://www.codium.ai/pricing/) trial. +To use Qodo Merge application on your private Bitbucket Server, you will need to contact us for starting an [Enterprise](https://www.codium.ai/pricing/) trial. -## Install Qodo Merge Pro for GitLab (Teams & Enterprise) +## Install Qodo Merge for GitLab (Teams & Enterprise) -Since GitLab platform does not support apps, installing Qodo Merge Pro for GitLab is a bit more involved, and requires the following steps: +Since GitLab platform does not support apps, installing Qodo Merge for GitLab is a bit more involved, and requires the following steps: #### Step 1 diff --git a/docs/docs/overview/pr_agent_pro.md b/docs/docs/overview/pr_agent_pro.md index 25a42ac8..79dda33a 100644 --- a/docs/docs/overview/pr_agent_pro.md +++ b/docs/docs/overview/pr_agent_pro.md @@ -5,7 +5,7 @@ Qodo Merge is designed for companies and teams that require additional features 1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the Qodo Merge app to your GitHub\GitLab\BitBucket repo. -2. **Improved privacy** - No data will be stored or used to train models. Qodo Merge Pro will employ zero data retention, and will use an OpenAI and Claude accounts with zero data retention. +2. **Improved privacy** - No data will be stored or used to train models. Qodo Merge will employ zero data retention, and will use an OpenAI and Claude accounts with zero data retention. 3. **Improved support** - Qodo Merge users will receive priority support, and will be able to request new features and capabilities. @@ -15,7 +15,7 @@ Qodo Merge is designed for companies and teams that require additional features ### Additional features -Here are some of the additional features and capabilities that Qodo Merge Pro offers: +Here are some of the additional features and capabilities that Qodo Merge offers: | Feature | Description | |----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -24,14 +24,14 @@ Here are some of the additional features and capabilities that Qodo Merge Pro of | [**Apply suggestions**](https://qodo-merge-docs.qodo.ai/tools/improve/#overview) | Generate committable code from the relevant suggestions interactively by clicking on a checkbox | | [**Suggestions impact**](https://qodo-merge-docs.qodo.ai/tools/improve/#assessing-impact) | Automatically mark suggestions that were implemented by the user (either directly in GitHub, or indirectly in the IDE) to enable tracking of the impact of the suggestions | | [**CI feedback**](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/) | Automatically analyze failed CI checks on GitHub and provide actionable feedback in the PR conversation, helping to resolve issues quickly | -| [**Advanced usage statistics**](https://www.codium.ai/contact/#/) | Qodo Merge Pro offers detailed statistics at user, repository, and company levels, including metrics about Qodo Merge usage, and also general statistics and insights | +| [**Advanced usage statistics**](https://www.codium.ai/contact/#/) | Qodo Merge offers detailed statistics at user, repository, and company levels, including metrics about Qodo Merge usage, and also general statistics and insights | | [**Incorporating companies' best practices**](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) | Use the companies' best practices as reference to increase the effectiveness and the relevance of the code suggestions | | [**Interactive triggering**](https://qodo-merge-docs.qodo.ai/tools/analyze/#example-usage) | Interactively apply different tools via the `analyze` command | -| [**Custom labels**](https://qodo-merge-docs.qodo.ai/tools/describe/#handle-custom-labels-from-the-repos-labels-page) | Define custom labels for Qodo Merge to assign to the PR | +| [**Custom labels**](https://qodo-merge-docs.qodo.ai/tools/describe/#handle-custom-labels-from-the-repos-labels-page) | Define custom labels for Qodo Merge to assign to the PR | ### Additional tools -Here are additional tools that are available only for Qodo Merge Pro users: +Here are additional tools that are available only for Qodo Merge users: | Feature | Description | |---------------------------------------------------------------------------------------|-------------| @@ -46,7 +46,7 @@ Here are additional tools that are available only for Qodo Merge Pro users: ### Supported languages -Qodo Merge Pro leverages the world's leading code models - Claude 3.5 Sonnet and GPT-4. +Qodo Merge leverages the world's leading code models - Claude 3.5 Sonnet and GPT-4. As a result, its primary tools such as `describe`, `review`, and `improve`, as well as the PR-chat feature, support virtually all programming languages. -For specialized commands that require static code analysis, Qodo Merge Pro offers support for specific languages. For more details about features that require static code analysis, please refer to the [documentation](https://qodo-merge-docs.qodo.ai/tools/analyze/#overview). +For specialized commands that require static code analysis, Qodo Merge offers support for specific languages. For more details about features that require static code analysis, please refer to the [documentation](https://qodo-merge-docs.qodo.ai/tools/analyze/#overview). diff --git a/docs/docs/tools/custom_labels.md b/docs/docs/tools/custom_labels.md index 6df57f90..cbc6ba0d 100644 --- a/docs/docs/tools/custom_labels.md +++ b/docs/docs/tools/custom_labels.md @@ -28,7 +28,7 @@ When working from CLI, you need to apply the [configuration changes](#configurat To enable custom labels, you need to apply the [configuration changes](#configuration-options) to the local `.pr_agent.toml` file in your repository. #### 3. Handle custom labels from the Repo's labels page 💎 -> This feature is available only in Qodo Merge Pro +> This feature is available only in Qodo Merge * GitHub : `https://github.com/{owner}/{repo}/labels`, or click on the "Labels" tab in the issues or PRs page. * GitLab : `https://gitlab.com/{owner}/{repo}/-/labels`, or click on "Manage" -> "Labels" on the left menu. diff --git a/docs/docs/usage-guide/PR_agent_pro_models.md b/docs/docs/usage-guide/PR_agent_pro_models.md index 008252ce..8cd1ed4c 100644 --- a/docs/docs/usage-guide/PR_agent_pro_models.md +++ b/docs/docs/usage-guide/PR_agent_pro_models.md @@ -1,10 +1,10 @@ ## Qodo Merge Models -The default models used by Qodo Merge Pro are a combination of Claude-3.5-sonnet and OpenAI's GPT-4 models. +The default models used by Qodo Merge are a combination of Claude-3.5-sonnet and OpenAI's GPT-4 models. -Users can configure Qodo Merge Pro to use solely a specific model by editing the [configuration](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) file. +Users can configure Qodo Merge to use solely a specific model by editing the [configuration](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) file. -For example, to restrict Qodo Merge Pro to using only `Claude-3.5-sonnet`, add this setting: +For example, to restrict Qodo Merge to using only `Claude-3.5-sonnet`, add this setting: ``` [config] diff --git a/docs/docs/usage-guide/automations_and_usage.md b/docs/docs/usage-guide/automations_and_usage.md index 947e056b..c38481cc 100644 --- a/docs/docs/usage-guide/automations_and_usage.md +++ b/docs/docs/usage-guide/automations_and_usage.md @@ -95,8 +95,8 @@ When this parameter is set to `true`, Qodo Merge will not run any automatic tool ### GitHub App -!!! note "Configurations for Qodo Merge Pro" - Qodo Merge Pro for GitHub is an App, hosted by CodiumAI. So all the instructions below are relevant also for Qodo Merge Pro users. +!!! note "Configurations for Qodo Merge" + Qodo Merge for GitHub is an App, hosted by Qodo. So all the instructions below are relevant also for Qodo Merge users. Same goes for [GitLab webhook](#gitlab-webhook) and [BitBucket App](#bitbucket-app) sections. #### GitHub app automatic tools when a new PR is opened diff --git a/docs/docs/usage-guide/configuration_options.md b/docs/docs/usage-guide/configuration_options.md index c97b6531..a65d34fb 100644 --- a/docs/docs/usage-guide/configuration_options.md +++ b/docs/docs/usage-guide/configuration_options.md @@ -20,7 +20,7 @@ In terms of precedence, wiki configurations will override local configurations, `Platforms supported: GitHub, GitLab, Bitbucket` -With Qodo Merge Pro, you can set configurations by creating a page called `.pr_agent.toml` in the [wiki](https://github.com/Codium-ai/pr-agent/wiki/pr_agent.toml) of the repo. +With Qodo Merge, you can set configurations by creating a page called `.pr_agent.toml` in the [wiki](https://github.com/Codium-ai/pr-agent/wiki/pr_agent.toml) of the repo. The advantage of this method is that it allows to set configurations without needing to commit new content to the repo - just edit the wiki page and **save**. diff --git a/docs/docs/usage-guide/index.md b/docs/docs/usage-guide/index.md index 567ba9f3..79e965a3 100644 --- a/docs/docs/usage-guide/index.md +++ b/docs/docs/usage-guide/index.md @@ -24,4 +24,4 @@ It includes information on how to adjust Qodo Merge configurations, define which - [Changing a model](./additional_configurations.md#changing-a-model) - [Patch Extra Lines](./additional_configurations.md#patch-extra-lines) - [Editing the prompts](./additional_configurations.md#editing-the-prompts) -- [Qodo Merge Pro Models](./PR_agent_pro_models.md) +- [Qodo Merge Models](./PR_agent_pro_models.md) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 96410556..5d2d55d6 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -5,7 +5,7 @@ repo_name: Codium-ai/pr-agent nav: - Overview: - 'index.md' - - 💎 Qodo Merge Pro: 'overview/pr_agent_pro.md' + - 💎 Qodo Merge: 'overview/pr_agent_pro.md' - Data Privacy: 'overview/data_privacy.md' - Installation: - 'installation/index.md' @@ -14,7 +14,7 @@ nav: - GitLab: 'installation/gitlab.md' - BitBucket: 'installation/bitbucket.md' - Azure DevOps: 'installation/azure.md' - - 💎 Qodo Merge Pro: 'installation/pr_agent_pro.md' + - 💎 Qodo Merge: 'installation/pr_agent_pro.md' - Usage Guide: - 'usage-guide/index.md' - Introduction: 'usage-guide/introduction.md' @@ -24,7 +24,7 @@ nav: - Managing Mail Notifications: 'usage-guide/mail_notifications.md' - Changing a Model: 'usage-guide/changing_a_model.md' - Additional Configurations: 'usage-guide/additional_configurations.md' - - 💎 Qodo Merge Pro Models: 'usage-guide/PR_agent_pro_models' + - 💎 Qodo Merge Models: 'usage-guide/PR_agent_pro_models' - Tools: - 'tools/index.md' - Describe: 'tools/describe.md' From fb3aa8c96c518a87b0f46b08f860cd8d9551d344 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Wed, 22 Jan 2025 21:20:44 +0200 Subject: [PATCH 3/3] docs: fix punctuation in Chrome extension documentation --- docs/docs/chrome-extension/features.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/chrome-extension/features.md b/docs/docs/chrome-extension/features.md index cb0d78ec..97c17aac 100644 --- a/docs/docs/chrome-extension/features.md +++ b/docs/docs/chrome-extension/features.md @@ -8,7 +8,7 @@ To enable private chat, simply install the Qodo Merge Chrome extension. After in This chat session is **private**, and won't be visible to other users. All open-source repositories are supported. -For private repositories, you will also need to install Qodo Merge, After installation, make sure to open at least one new PR to fully register your organization. Once done, you can chat with both new and existing PRs across all installed repositories. +For private repositories, you will also need to install Qodo Merge. After installation, make sure to open at least one new PR to fully register your organization. Once done, you can chat with both new and existing PRs across all installed repositories. #### Context-aware PR chat