From c90e72cb756939cd3111291701e4ea2779f8b88b Mon Sep 17 00:00:00 2001 From: mrT23 Date: Fri, 29 Sep 2023 11:30:47 +0300 Subject: [PATCH] Improve --- README.md | 3 ++- Usage.md | 2 +- docs/DESCRIBE.md | 4 ++-- docs/SIMILAR_ISSUE.md | 6 +++--- docs/TOOLS_GUIDE.md | 5 +++++ 5 files changed, 13 insertions(+), 7 deletions(-) create mode 100644 docs/TOOLS_GUIDE.md diff --git a/README.md b/README.md index 597a1583..5b19b9d1 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,8 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review pull ‣ **Find similar issue ([`/similar_issue`](./docs/SIMILAR_ISSUE.md))**: Automatically retrieves and presents similar issues -See the [usage guide](./Usage.md) for instructions how to run the different tools from [CLI](./Usage.md#working-from-a-local-repo-cli), or by [online usage](./Usage.md#online-usage), as well as additional details on optional commands and configurations. +See the [Usage Guide](./Usage.md) for instructions how to run the different tools from CLI, online usage, Or by automatically triggering them when a new PR is opened. +See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the different tools. [Release notes](./RELEASE_NOTES.md) diff --git a/Usage.md b/Usage.md index f316ddaa..71991f15 100644 --- a/Usage.md +++ b/Usage.md @@ -1,4 +1,4 @@ -## Usage guide +## Usage Guide ### Table of Contents - [Introduction](#introduction) diff --git a/docs/DESCRIBE.md b/docs/DESCRIBE.md index 1d09e71d..bdab909a 100644 --- a/docs/DESCRIBE.md +++ b/docs/DESCRIBE.md @@ -7,9 +7,9 @@ It can ba invoked manually by commenting on any PR: ``` For example: - + - + The `describe` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action) diff --git a/docs/SIMILAR_ISSUE.md b/docs/SIMILAR_ISSUE.md index 954109c6..ac7f0157 100644 --- a/docs/SIMILAR_ISSUE.md +++ b/docs/SIMILAR_ISSUE.md @@ -6,9 +6,9 @@ It can ba invoked manually by commenting on any PR: ``` For example: - - - + + + Note that to perform retrieval, the `similar_issue` tool indexes all the repo previous issues (once). diff --git a/docs/TOOLS_GUIDE.md b/docs/TOOLS_GUIDE.md new file mode 100644 index 00000000..1dbd4023 --- /dev/null +++ b/docs/TOOLS_GUIDE.md @@ -0,0 +1,5 @@ +## Table of Contents +- [DESCRIBE](./DESCRIBE.md) +- [REVIEW](./REVIEW.md) +- [IMPROVE](./IMPROVE.md) +- [SIMILAR_ISSUE](./SIMILAR_ISSUE.md) \ No newline at end of file