Skip to content

Commit

Permalink
Update README.md with new documentation portal links
Browse files Browse the repository at this point in the history
  • Loading branch information
mrT23 committed Mar 10, 2024
1 parent fabb299 commit ab2ac03
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 43 deletions.
52 changes: 24 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,29 +104,31 @@ Supported commands per platform:
[//]: # (- Support for additional git providers is described in [here](./docs/Full_environments.md))
___

**Auto Description ([`/describe`](./docs/DESCRIBE.md))**: Automatically generating PR description - title, type, summary, code walkthrough and labels.
**Auto Description ([`/describe`](https://codium-ai.github.io/Docs-PR-Agent/tools/describe/))**: Automatically generating PR description - title, type, summary, code walkthrough and labels.
\
**Auto Review ([`/review`](./docs/REVIEW.md))**: Adjustable feedback about the PR, possible issues, security concerns, review effort and more.
**Auto Review ([`/review`](https://codium-ai.github.io/Docs-PR-Agent/tools/review/))**: Adjustable feedback about the PR, possible issues, security concerns, review effort and more.
\
**Question Answering ([`/ask ...`](./docs/ASK.md))**: Answering free-text questions about the PR.
**Code Suggestions ([`/improve`](https://codium-ai.github.io/Docs-PR-Agent/tools/improve/))**: Code suggestions for improving the PR.
\
**Code Suggestions ([`/improve`](./docs/IMPROVE.md))**: Code suggestions for improving the PR.
**Question Answering ([`/ask ...`](https://codium-ai.github.io/Docs-PR-Agent/tools/ask/))**: Answering free-text questions about the PR.
\
**Update Changelog ([`/update_changelog`](./docs/UPDATE_CHANGELOG.md))**: Automatically updating the CHANGELOG.md file with the PR changes.
**Update Changelog ([`/update_changelog`](https://codium-ai.github.io/Docs-PR-Agent/tools/update_changelog/))**: Automatically updating the CHANGELOG.md file with the PR changes.
\
**Find Similar Issue ([`/similar_issue`](./docs/SIMILAR_ISSUE.md))**: Automatically retrieves and presents similar issues.
**Find Similar Issue ([`/similar_issue`](https://codium-ai.github.io/Docs-PR-Agent/tools/similar_issues/))**: Automatically retrieves and presents similar issues.
\
**Add Documentation 💎 ([`/add_docs`](./docs/ADD_DOCUMENTATION.md))**: Generates documentation to methods/functions/classes that changed in the PR.
**Add Documentation 💎 ([`/add_docs`](https://codium-ai.github.io/Docs-PR-Agent/tools/documentation/))**: Generates documentation to methods/functions/classes that changed in the PR.
\
**Generate Custom Labels 💎 ([`/generate_labels`](./docs/GENERATE_CUSTOM_LABELS.md))**: Generates custom labels for the PR, based on specific guidelines defined by the user.
**Generate Custom Labels 💎 ([`/generate_labels`](https://codium-ai.github.io/Docs-PR-Agent/tools/custom_labels/))**: Generates custom labels for the PR, based on specific guidelines defined by the user.
\
**Analyze 💎 ([`/analyze`](./docs/Analyze.md))**: Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component.
**Analyze 💎 ([`/analyze`](https://codium-ai.github.io/Docs-PR-Agent/tools/analyze/))**: Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component.
\
**Custom Suggestions 💎 ([`/custom_suggestions`](./docs/CUSTOM_SUGGESTIONS.md))**: Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.
**Custom Suggestions 💎 ([`/custom_suggestions`](https://codium-ai.github.io/Docs-PR-Agent/tools/custom_suggestions/))**: Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.
\
**Generate Tests 💎 ([`/test component_name`](./docs/TEST.md))**: Automatically generates unit tests for a selected component, based on the PR code changes.
**Generate Tests 💎 ([`/test component_name`](https://codium-ai.github.io/Docs-PR-Agent/tools/test/))**: Generates unit tests for a selected component, based on the PR code changes.
\
**CI Feedback 💎 ([`/checks ci_job`](./docs/CI_FEEDBACK.md))**: Automatically generates feedback and analysis for a failed CI job.
**CI Feedback 💎 ([`/checks ci_job`](https://codium-ai.github.io/Docs-PR-Agent/tools/ci_feedback/))**: Automatically generates feedback and analysis for a failed CI job.
\
**Similar Code 💎 ([`/find_similar_component`](https://codium-ai.github.io/Docs-PR-Agent/tools/similar_code//))**: Retrieves the most similar code components from inside the organization's codebase, or from open-source code.
___

## Example results
Expand Down Expand Up @@ -220,7 +222,7 @@ and the agent will respond with a review of your PR
![Review generation process](https://www.codium.ai/images/demo-2.gif)


To set up your own PR-Agent, see the [Installation](#installation) section below.
To set up your own PR-Agent, see the [Installation](https://codium-ai.github.io/Docs-PR-Agent/installation/) section below.
Note that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, there is no need to mention `@CodiumAI-Agent ...`. Instead, directly start with the command, e.g., `/ask ...`.

---
Expand All @@ -234,32 +236,26 @@ To use your own version of PR-Agent, you first need to acquire two tokens:
There are several ways to use PR-Agent:

**Locally**
- [Use Docker image (no installation required)](./INSTALL.md#use-docker-image-no-installation-required)
- [Run from source](./INSTALL.md#run-from-source)
- [Use Docker image (no installation required)](https://codium-ai.github.io/Docs-PR-Agent/installation/locally/#use-docker-image-no-installation-required)
- [Run from source](https://codium-ai.github.io/Docs-PR-Agent/installation/locally/#run-from-source)

**GitHub specific methods**
- [Run as a GitHub Action](./INSTALL.md#run-as-a-github-action)
- [Run as a GitHub App](./INSTALL.md#run-as-a-github-app)
- [Run as a GitHub Action](https://codium-ai.github.io/Docs-PR-Agent/installation/github/#run-as-a-github-action)
- [Run as a GitHub App](https://codium-ai.github.io/Docs-PR-Agent/installation/github/#run-as-a-github-app)

**GitLab specific methods**
- [Run a GitLab webhook server](./INSTALL.md#run-a-gitlab-webhook-server)
- [Run a GitLab webhook server](https://codium-ai.github.io/Docs-PR-Agent/installation/gitlab/)

**BitBucket specific methods**
- [Run as a Bitbucket Pipeline](./INSTALL.md#run-as-a-bitbucket-pipeline)
- [Run as a Bitbucket Pipeline](https://codium-ai.github.io/Docs-PR-Agent/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.
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:
- [**Analyze PR components**](https://github.com/Codium-ai/pr-agent/blob/main/docs/Analyze.md)
- [**Custom Code Suggestions**](https://github.com/Codium-ai/pr-agent/blob/main/docs/CUSTOM_SUGGESTIONS.md)
- [**Tests**](https://github.com/Codium-ai/pr-agent/blob/main/docs/TEST.md)
- [**PR documentation**](https://github.com/Codium-ai/pr-agent/blob/main/docs/ADD_DOCUMENTATION.md)
- [**SOC2 compliance check**](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#soc2-ticket-compliance-)
- [**Custom labels**](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#handle-custom-labels-from-the-repos-labels-page-gem)
- [**Global configuration**](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#global-configuration-file-)
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.
See [here](https://codium-ai.github.io/Docs-PR-Agent/#pr-agent-pro) for a list of features available in PR-Agent Pro.



Expand All @@ -269,7 +265,7 @@ The following diagram illustrates PR-Agent tools and their flow:

![PR-Agent Tools](https://codium.ai/images/pr_agent/diagram-v0.9.png)

Check out the [PR Compression strategy](./PR_COMPRESSION.md) page for more details on how we convert a code diff to a manageable LLM prompt
Check out the [PR Compression strategy](https://codium-ai.github.io/Docs-PR-Agent/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?

Expand Down
16 changes: 1 addition & 15 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,21 +152,7 @@ Check out the [PR Compression strategy](core-abilities/index.md) page for more d
- [**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)



## 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:

- PR-Agent emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single GPT-4 call, no more. We believe this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably.
- PR-Agent [Compression strategy](core-abilities/index.md) is a core ability that enables to effectively tackle both short and long PRs.
- YAML prompting strategy enables to have **modular, customizable, highly efficient tools**.
- PR-Agent is flexible and **highly configurable**.
- PR-Agent supports **multiple git providers** (GitHub, Gitlab, Bitbucket, Azure devops), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT-4, GPT-3.5, Anthropic, Cohere, Llama, ...).



## 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:
Expand Down

0 comments on commit ab2ac03

Please sign in to comment.