diff --git a/README.md b/README.md index 5b19b9d1..b9395ce4 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review pull \ ‣ **Auto Review ([`/review`](./docs/REVIEW.md))**: Adjustable feedback about the PR main theme, type, relevant tests, security issues, score, and various suggestions for the PR content. \ -‣ **Question Answering (`/ask ...`)**: Answering [free-text questions](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021332) about the PR. +‣ **Question Answering ([`/ask ...`](./docs/ASK.md))**: Answering free-text questions about the PR. \ ‣ **Code Suggestions ([`/improve`](./docs/IMPROVE.md))**: Committable code suggestions for improving the PR. \ @@ -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, online usage, Or by automatically triggering them when a new PR is opened. +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/docs/ASK.md b/docs/ASK.md new file mode 100644 index 00000000..9ac737e5 --- /dev/null +++ b/docs/ASK.md @@ -0,0 +1,11 @@ +# ASK Tool + +The `ask` tool answers questions about the PR, based on the PR code changes. +It can be invoked manually by commenting on any PR: +``` +/ask "..." +``` +For example: + + + \ No newline at end of file diff --git a/docs/IMPROVE.md b/docs/IMPROVE.md index 748fdaf8..73682c1b 100644 --- a/docs/IMPROVE.md +++ b/docs/IMPROVE.md @@ -1,14 +1,14 @@ # Describe Tool The `improve` tool scans the PR code changes, and automatically generate committable suggestions for improving the PR code. -It can ba invoked manually by commenting on any PR: +It can be invoked manually by commenting on any PR: ``` /improve ``` For example: - + The `improve` 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) @@ -16,7 +16,7 @@ An extended mode, which does not involve PR Compression and provides more compre ``` /improve --extended ``` -Note that the extended mode divides the PR code changes into chunks, due to token limits, where each chunk is handled separately (multiple calls to GPT-4). +Note that the extended mode divides the PR code changes into chunks, up to the token limits, where each chunk is handled separately (multiple calls to GPT-4). Hence, the total number of suggestions is proportional to the number of chunks, i.e. the size of the PR. ### Configuration options diff --git a/docs/REVIEW.md b/docs/REVIEW.md index bf4c3e98..92c67196 100644 --- a/docs/REVIEW.md +++ b/docs/REVIEW.md @@ -8,7 +8,7 @@ It can ba invoked manually by commenting on any PR: For example: - + The `review` 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/TOOLS_GUIDE.md b/docs/TOOLS_GUIDE.md index 1dbd4023..5b3179c8 100644 --- a/docs/TOOLS_GUIDE.md +++ b/docs/TOOLS_GUIDE.md @@ -1,5 +1,6 @@ -## Table of Contents +## Tools Guide - [DESCRIBE](./DESCRIBE.md) - [REVIEW](./REVIEW.md) - [IMPROVE](./IMPROVE.md) +- [ASK](./ASK.md) - [SIMILAR_ISSUE](./SIMILAR_ISSUE.md) \ No newline at end of file diff --git a/pics/ask.png b/pics/ask.png new file mode 100644 index 00000000..4923829c Binary files /dev/null and b/pics/ask.png differ diff --git a/pics/ask_comment.png b/pics/ask_comment.png new file mode 100644 index 00000000..a9d0204d Binary files /dev/null and b/pics/ask_comment.png differ