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 ab2ac03 commit a868427
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 16 deletions.
25 changes: 10 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,25 +32,20 @@ Making pull requests less painful with an AI agent

## News and Updates

### Feb 29, 2024
- You can now use the repo's [wiki page](https://codium-ai.github.io/Docs-PR-Agent/usage-guide/configuration_options/) to set configurations for PR-Agent 💎

<kbd><img src="https://codium.ai/images/pr_agent/wiki_configuration.png" width="512"></kbd>

### Jan 10, 2024
- A new documentation website is now available for PR-Agent. It includes detailed information about the different tools, usage guides, and more. You can access it [here](https://codium-ai.github.io/Docs-PR-Agent/)

### Feb 21, 2024
- Added a new command, `/help`, to easily provide a list of available tools and their descriptions, and run them interactively.
### Jan 8, 2024

<kbd>
- A new tool, [Find Similar Code](https://codium-ai.github.io/Docs-PR-Agent/tools/similar_code/) 💎 is now available. This tool retrieves the most similar code components from inside the organization's codebase, or from open-source code.
<kbd><a href="https://codium.ai/images/pr_agent/https://codium.ai/images/similar_code.mp4"><img src="https://codium.ai/images/pr_agent/https://codium.ai/images/pr_agent/similar_code_global2.png" width="512"></a></kbd>

<img src="https://www.codium.ai/images/pr_agent/help.png" width="512">
(click on the image to see an instructional video)

</kbd>
### Feb 29, 2024
- You can now use the repo's [wiki page](https://codium-ai.github.io/Docs-PR-Agent/usage-guide/configuration_options/) to set configurations for PR-Agent 💎

### Feb 18, 2024
- Introducing the `CI Feedback` tool 💎. The tool automatically triggers when a PR has a failed check. It analyzes the failed check, and provides summarized logs and analysis. Note that this feature requires read access to GitHub 'checks' and 'actions'. See [here](./docs/CI_FEEDBACK.md) for more details.
- New ability - you can run `/ask` on specific lines of code in the PR from the PR's diff view. See [here](https://codium-ai.github.io/Docs-PR-Agent/tools/ask/#ask-lines) for more details.
- Introducing support for [Azure DevOps Webhooks](https://codium-ai.github.io/Docs-PR-Agent/usage-guide/automations_and_usage/#azure-devops-provider), as well as bug fixes and improved support for several ADO commands.
<kbd><img src="https://codium.ai/images/pr_agent/wiki_configuration.png" width="512"></kbd>


## Overview
Expand Down Expand Up @@ -274,7 +269,7 @@ A reasonable question that can be asked is: `"Why use PR-Agent? What makes it st
Here are some advantages of PR-Agent:

- We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single GPT-4 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](./PR_COMPRESSION.md) is a core ability that enables to effectively tackle both short and long PRs.
- Our [PR Compression strategy](https://codium-ai.github.io/Docs-PR-Agent/core-abilities/#pr-compression-strategy) is a core ability that enables to effectively tackle both short and long PRs.
- Our JSON prompting strategy enables 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-4, GPT-3.5, Anthropic, Cohere, Llama2).

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ CodiumAI PR-Agent is an open-source tool to help efficiently review and handle p
- See the [Tools Guide](./tools/index.md) for a detailed description of the different tools (tools are run via the commands).


## Features table
## PR-Agent Features
PR-Agent offers extensive pull request functionalities across various git providers.

| | | GitHub | Gitlab | Bitbucket | Azure DevOps |
Expand Down

0 comments on commit a868427

Please sign in to comment.