diff --git a/README.md b/README.md index 0d75489c..de3f51e5 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,6 @@ CodiumAI PR-Agent aims to help efficiently review and handle pull requests, by p - [Overview](#overview) - [Example results](#example-results) - [Try it now](#try-it-now) -- [Installation](#installation) - [PR-Agent Pro 💎](#pr-agent-pro-) - [How it works](#how-it-works) - [Why use PR-Agent?](#why-use-pr-agent) @@ -235,32 +234,47 @@ Note that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, there --- -## Installation -To use your own version of PR-Agent, you first need to acquire two tokens: +[//]: # (## Installation) -1. An OpenAI key from [here](https://platform.openai.com/), with access to GPT-4. -2. A GitHub personal access token (classic) with the repo scope. +[//]: # (To use your own version of PR-Agent, you first need to acquire two tokens:) -There are several ways to use PR-Agent: +[//]: # () +[//]: # (1. An OpenAI key from [here](https://platform.openai.com/), with access to GPT-4.) -**Locally** -- [Using pip package](https://pr-agent-docs.codium.ai/installation/locally/#using-pip-package) -- [Using Docker image](https://pr-agent-docs.codium.ai/installation/locally/#using-docker-image) -- [Run from source](https://pr-agent-docs.codium.ai/installation/locally/#run-from-source) +[//]: # (2. A GitHub personal access token (classic) with the repo scope.) -**GitHub specific methods** -- [Run as a GitHub Action](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-action) -- [Run as a GitHub App](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-app) +[//]: # () +[//]: # (There are several ways to use PR-Agent:) -**GitLab specific methods** -- [Run a GitLab webhook server](https://pr-agent-docs.codium.ai/installation/gitlab/) +[//]: # () +[//]: # (**Locally**) -**BitBucket specific methods** -- [Run as a Bitbucket Pipeline](https://pr-agent-docs.codium.ai/installation/bitbucket/) +[//]: # (- [Using pip package](https://pr-agent-docs.codium.ai/installation/locally/#using-pip-package)) + +[//]: # (- [Using Docker image](https://pr-agent-docs.codium.ai/installation/locally/#using-docker-image)) + +[//]: # (- [Run from source](https://pr-agent-docs.codium.ai/installation/locally/#run-from-source)) + +[//]: # () +[//]: # (**GitHub specific methods**) + +[//]: # (- [Run as a GitHub Action](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-action)) + +[//]: # (- [Run as a GitHub App](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-app)) + +[//]: # () +[//]: # (**GitLab specific methods**) + +[//]: # (- [Run a GitLab webhook server](https://pr-agent-docs.codium.ai/installation/gitlab/)) + +[//]: # () +[//]: # (**BitBucket specific methods**) + +[//]: # (- [Run as a Bitbucket Pipeline](https://pr-agent-docs.codium.ai/installation/bitbucket/)) ## PR-Agent Pro 💎 [PR-Agent Pro](https://www.codium.ai/pricing/) is a hosted version of PR-Agent, provided by CodiumAI. It is available for a monthly fee, and 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 PR-Agent app to your GitHub\BitBucket repo. +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 PR-Agent app to your GitHub\GitLab\BitBucket repo. 2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention. 3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities. 4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. diff --git a/docs/docs/index.md b/docs/docs/index.md index 3919feae..cec35b45 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -45,7 +45,7 @@ PR-Agent offers extensive pull request functionalities across various git provid 💎 marks a feature available only in [PR-Agent Pro](https://www.codium.ai/pricing/){:target="_blank"} -## Example results +## 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} @@ -66,7 +66,7 @@ PR-Agent offers extensive pull request functionalities across various git provid ![/generate_labels](https://www.codium.ai/images/pr_agent/geneare_custom_labels_main_short.png){width=300}
-## How it works +## How it Works The following diagram illustrates PR-Agent tools and their flow: @@ -80,7 +80,7 @@ Check out the [PR Compression strategy](core-abilities/index.md) page for more d [PR-Agent Pro](https://www.codium.ai/pricing/) is a hosted version of PR-Agent, provided by CodiumAI. It is available for a monthly fee, and 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 PR-Agent app to your GitHub\BitBucket repo. +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 PR-Agent app to your GitHub\GitLab\BitBucket repo. 2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention. 3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities. 4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. It has the following additional tools and features: @@ -88,13 +88,15 @@ Check out the [PR Compression strategy](core-abilities/index.md) page for more d - [**Custom Code Suggestions**](./tools/custom_suggestions.md/) - [**Tests**](./tools/test.md/) - [**PR documentation**](./tools/documentation.md/) + - [**Improve Component**](https://pr-agent-docs.codium.ai/tools/improve_component/) + - [**Similar code search**](https://pr-agent-docs.codium.ai/tools/similar_code/) - [**CI feedback**](./tools/ci_feedback.md/) - [**SOC2 compliance check**](./tools/review.md/#soc2-ticket-compliance) - [**Custom labels**](./tools/describe.md/#handle-custom-labels-from-the-repos-labels-page) - [**Global and wiki configuration**](./usage-guide/configuration_options.md/#wiki-configuration-file) -## Data privacy +## Data Privacy If you host PR-Agent with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here: https://openai.com/enterprise-privacy diff --git a/docs/docs/installation/index.md b/docs/docs/installation/index.md index fc71ecbb..f8b64a27 100644 --- a/docs/docs/installation/index.md +++ b/docs/docs/installation/index.md @@ -1,6 +1,6 @@ # Installation -## self-hosted PR-Agent +## Self-hosted PR-Agent If you choose to host you own PR-Agent, you first need to acquire two tokens: 1. An OpenAI key from [here](https://platform.openai.com/api-keys), with access to GPT-4 (or a key for [other models](../usage-guide/additional_configurations.md/#changing-a-model), if you prefer). diff --git a/docs/docs/usage-guide/automations_and_usage.md b/docs/docs/usage-guide/automations_and_usage.md index f32863eb..3d23c491 100644 --- a/docs/docs/usage-guide/automations_and_usage.md +++ b/docs/docs/usage-guide/automations_and_usage.md @@ -50,6 +50,10 @@ Any configuration value in [configuration file](https://github.com/Codium-ai/pr- ## GitHub App +!!! note "Configurations for PR-Agent Pro" + PR-Agent Pro for GitHub is an App, hosted by CodiumAI. So all the instructions below are relevant also for PR-Agent Pro users. + Same goes for [GitLab webhook](#gitlab-webhook) and [BitBucket App](#bitbucket-app) sections. + ### GitHub app automatic tools when a new PR is opened The [github_app](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L108) section defines GitHub app specific configurations. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index c045d8e4..a34c1bc0 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -14,7 +14,7 @@ nav: - 'usage-guide/index.md' - Introduction: 'usage-guide/introduction.md' - Configuration Options: 'usage-guide/configuration_options.md' - - Managing email notifications: 'usage-guide/mail_notifications.md' + - Managing Mail Notifications: 'usage-guide/mail_notifications.md' - Usage and Automation: 'usage-guide/automations_and_usage.md' - Additional Configurations: 'usage-guide/additional_configurations.md' - Tools: