From 62df50cf8643e81fd6a58c55a540b0390e8e5ba4 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Thu, 18 Jul 2024 10:58:39 +0300 Subject: [PATCH] docs --- README.md | 112 +++++++----------- docs/docs/index.md | 42 +++---- docs/docs/installation/index.md | 5 +- .../docs/usage-guide/configuration_options.md | 2 +- 4 files changed, 64 insertions(+), 97 deletions(-) diff --git a/README.md b/README.md index dddcbd56..86903c25 100644 --- a/README.md +++ b/README.md @@ -73,40 +73,40 @@ New option now available (💎) - **apply suggestions**: Supported commands per platform: -| | | GitHub | Gitlab | Bitbucket | Azure DevOps | -|-------|---------------------------------------------------------------------------------------------------------|:--------------------:|:--------------------:|:--------------------:|:--------------------:| -| TOOLS | Review | ✅ | ✅ | ✅ | ✅ | -| | ⮑ Incremental | ✅ | | | | -| | ⮑ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance) 💎 | ✅ | ✅ | ✅ | ✅ | -| | Describe | ✅ | ✅ | ✅ | ✅ | -| | ⮑ [Inline File Summary](https://pr-agent-docs.codium.ai/tools/describe#inline-file-summary) 💎 | ✅ | | | | -| | Improve | ✅ | ✅ | ✅ | ✅ | -| | ⮑ Extended | ✅ | ✅ | ✅ | ✅ | -| | Ask | ✅ | ✅ | ✅ | ✅ | -| | ⮑ [Ask on code lines](https://pr-agent-docs.codium.ai/tools/ask#ask-lines) | ✅ | ✅ | | | -| | [Custom Prompt](https://pr-agent-docs.codium.ai/tools/custom_prompt/) 💎 | ✅ | ✅ | ✅ | ✅ | -| | [Test](https://pr-agent-docs.codium.ai/tools/test/) 💎 | ✅ | ✅ | | ✅ | -| | Reflect and Review | ✅ | ✅ | ✅ | ✅ | -| | Update CHANGELOG.md | ✅ | ✅ | ✅ | ✅ | -| | Find Similar Issue | ✅ | | | | -| | [Add 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/) 💎 | ✅ | ✅ | | ✅ | -| | [CI Feedback](https://pr-agent-docs.codium.ai/tools/ci_feedback/) 💎 | ✅ | | | | -| | [Similar Code](https://pr-agent-docs.codium.ai/tools/similar_code/) 💎 | ✅ | | | | -| | | | | | | -| USAGE | CLI | ✅ | ✅ | ✅ | ✅ | -| | App / webhook | ✅ | ✅ | ✅ | ✅ | -| | Tagging bot | ✅ | | | | -| | Actions | ✅ | | ✅ | | -| | | | | | | -| CORE | PR compression | ✅ | ✅ | ✅ | ✅ | -| | Repo language prioritization | ✅ | ✅ | ✅ | ✅ | -| | Adaptive and token-aware file patch fitting | ✅ | ✅ | ✅ | ✅ | -| | Multiple models support | ✅ | ✅ | ✅ | ✅ | -| | [Static code analysis](https://pr-agent-docs.codium.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) 💎 | ✅ | | | | +| | | GitHub | Gitlab | Bitbucket | Azure DevOps | +|-------|---------------------------------------------------------------------------------------------------------|:--------------------:|:--------------------:|:--------------------:|:------------:| +| TOOLS | Review | ✅ | ✅ | ✅ | ✅ | +| | ⮑ Incremental | ✅ | | | | +| | ⮑ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance) 💎 | ✅ | ✅ | ✅ | | +| | Describe | ✅ | ✅ | ✅ | ✅ | +| | ⮑ [Inline File Summary](https://pr-agent-docs.codium.ai/tools/describe#inline-file-summary) 💎 | ✅ | | | | +| | Improve | ✅ | ✅ | ✅ | ✅ | +| | ⮑ Extended | ✅ | ✅ | ✅ | ✅ | +| | Ask | ✅ | ✅ | ✅ | ✅ | +| | ⮑ [Ask on code lines](https://pr-agent-docs.codium.ai/tools/ask#ask-lines) | ✅ | ✅ | | | +| | [Custom Prompt](https://pr-agent-docs.codium.ai/tools/custom_prompt/) 💎 | ✅ | ✅ | ✅ | | +| | [Test](https://pr-agent-docs.codium.ai/tools/test/) 💎 | ✅ | ✅ | | | +| | Reflect and Review | ✅ | ✅ | ✅ | ✅ | +| | Update CHANGELOG.md | ✅ | ✅ | ✅ | ✅ | +| | Find Similar Issue | ✅ | | | | +| | [Add 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/) 💎 | ✅ | ✅ | | | +| | [CI Feedback](https://pr-agent-docs.codium.ai/tools/ci_feedback/) 💎 | ✅ | | | | +| | [Similar Code](https://pr-agent-docs.codium.ai/tools/similar_code/) 💎 | ✅ | | | | +| | | | | | | +| USAGE | CLI | ✅ | ✅ | ✅ | ✅ | +| | App / webhook | ✅ | ✅ | ✅ | ✅ | +| | Tagging bot | ✅ | | | | +| | Actions | ✅ | | ✅ | | +| | | | | | | +| CORE | PR compression | ✅ | ✅ | ✅ | ✅ | +| | Repo language prioritization | ✅ | ✅ | ✅ | ✅ | +| | Adaptive and token-aware file patch fitting | ✅ | ✅ | ✅ | ✅ | +| | Multiple models support | ✅ | ✅ | ✅ | ✅ | +| | [Static code analysis](https://pr-agent-docs.codium.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) 💎 | ✅ | ✅ | | | - 💎 means this feature is available only in [PR-Agent Pro](https://www.codium.ai/pricing/) [//]: # (- Support for additional git providers is described in [here](./docs/Full_environments.md)) @@ -225,7 +225,12 @@ For example, add a comment to any pull request with the following text: ``` @CodiumAI-Agent /review ``` -and the agent will respond with a review of your PR +and the agent will respond with a review of your PR. + +Note that this is a promotional bot, suitable only for initial experimentation. +It does not have `edit` access to you repo, for example, so it cannot update the PR description or add labels. +Comment: `@CodiumAI-Agent /describe --pr_description.publish_description_as_comment=true` to publish the description as a comment in the PR. +`@CodiumAI-Agent /review` and `@CodiumAI-Agent /improve` should work as-is. ![Review generation process](https://www.codium.ai/images/demo-2.gif) @@ -235,43 +240,6 @@ 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:) - -[//]: # () -[//]: # (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.) - -[//]: # () -[//]: # (There are several ways to use PR-Agent:) - -[//]: # () -[//]: # (**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)) - -[//]: # () -[//]: # (**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: diff --git a/docs/docs/index.md b/docs/docs/index.md index 26705e37..6e2ebd88 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -14,33 +14,33 @@ PR-Agent offers extensive pull request functionalities across various git provid | | | GitHub | Gitlab | Bitbucket | Azure DevOps | |-------|-----------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:| -| TOOLS | Review | ✅ | ✅ | ✅ | ✅ | +| TOOLS | Review | ✅ | ✅ | ✅ | ✅ | | | ⮑ Incremental | ✅ | | | | -| | ⮑ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ | -| | Ask | ✅ | ✅ | ✅ | ✅ | -| | Describe | ✅ | ✅ | ✅ | ✅ | -| | ⮑ [Inline file summary](https://pr-agent-docs.codium.ai/tools/describe/#inline-file-summary){:target="_blank"} 💎 | ✅ | ✅ | | ✅ | -| | Improve | ✅ | ✅ | ✅ | ✅ | -| | ⮑ Extended | ✅ | ✅ | ✅ | ✅ | -| | [Custom Prompt](./tools/custom_prompt.md){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ | -| | Reflect and Review | ✅ | ✅ | ✅ | ✅ | +| | ⮑ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance){:target="_blank"} 💎 | ✅ | ✅ | ✅ | | +| | Ask | ✅ | ✅ | ✅ | ✅ | +| | Describe | ✅ | ✅ | ✅ | ✅ | +| | ⮑ [Inline file summary](https://pr-agent-docs.codium.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"} 💎 | ✅ | ✅ | | ✅ | +| | [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"} 💎 | ✅ | ✅ | | | | | | | | | ️ | -| USAGE | CLI | ✅ | ✅ | ✅ | ✅ | -| | App / webhook | ✅ | ✅ | ✅ | ✅ | +| 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"} 💎 | ✅ | ✅ | ✅ | ✅ | +| 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 [PR-Agent Pro](https://www.codium.ai/pricing/){:target="_blank"} diff --git a/docs/docs/installation/index.md b/docs/docs/installation/index.md index f8b64a27..c82e6bd0 100644 --- a/docs/docs/installation/index.md +++ b/docs/docs/installation/index.md @@ -15,8 +15,7 @@ There are several ways to use self-hosted PR-Agent: - [Azure DevOps](./azure.md) ## PR-Agent Pro 💎 -PR-Agent Pro, an app for GitHub\GitLab\BitBucket hosted by CodiumAI, is also available. -
-With PR-Agent Pro Installation is as simple as signing up and adding the PR-Agent app to your relevant repo. +PR-Agent Pro, an app hosted by CodiumAI for GitHub\GitLab\BitBucket, is also available.
+With PR-Agent Pro, installation is as simple as signing up and adding the PR-Agent app to your relevant repo. See [here](./pr_agent_pro.md) for more details. \ No newline at end of file diff --git a/docs/docs/usage-guide/configuration_options.md b/docs/docs/usage-guide/configuration_options.md index 6974c121..d0cf0bae 100644 --- a/docs/docs/usage-guide/configuration_options.md +++ b/docs/docs/usage-guide/configuration_options.md @@ -59,7 +59,7 @@ Then you can give a list of extra instructions to the `review` tool. ## Global configuration file 💎 -`Platforms supported: GitHub, GitLab, Bitbucket, Azure DevOps` +`Platforms supported: GitHub, GitLab, Bitbucket` If you create a repo called `pr-agent-settings` in your **organization**, it's configuration file `.pr_agent.toml` will be used as a global configuration file for any other repo that belongs to the same organization. Parameters from a local `.pr_agent.toml` file, in a specific repo, will override the global configuration parameters.