From 6b56ea4289db83b77778af417edb51d4aefc9325 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Tue, 18 Jun 2024 09:40:05 +0300 Subject: [PATCH] mkdocs --- docs/docs/index.md | 81 ++++++++++++++++++++++++++++++++++++++++++++++ docs/mkdocs.yml | 3 +- 2 files changed, 82 insertions(+), 2 deletions(-) create mode 100644 docs/docs/index.md diff --git a/docs/docs/index.md b/docs/docs/index.md new file mode 100644 index 00000000..26705e37 --- /dev/null +++ b/docs/docs/index.md @@ -0,0 +1,81 @@ +# Overview + +CodiumAI PR-Agent 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 PR-Agent 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. + + +## PR-Agent Features +PR-Agent offers extensive pull request functionalities across various git providers. + +| | | GitHub | Gitlab | Bitbucket | Azure DevOps | +|-------|-----------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:| +| 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 | ✅ | ✅ | ✅ | ✅ | +| | 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"} 💎 | ✅ | ✅ | | ✅ | +| | | | | | ️ | +| 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 [PR-Agent 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 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](core-abilities/index.md) page for more details on how we convert a code diff to a manageable LLM prompt \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index b5978b9f..f022df04 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -4,7 +4,7 @@ repo_name: Codium-ai/pr-agent nav: - Overview: - - 'overview/index.md' + - 'index.md' - 💎 PR-Agent Pro: 'overview/pr_agent_pro.md' - Data Privacy: 'overview/data_privacy.md' - Installation: @@ -134,6 +134,5 @@ markdown_extensions: title: On this page toc_depth: 2 permalink: true - - attr_list copyright: | © 2024 CodiumAI