xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-05 05:10:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

Refactor markdown image syntax and enhance documentation presentation

Browse Source
This commit is contained in:
Almog Lavi
2024-03-26 23:00:57 +02:00
parent 26c4a98fc8
commit 736c8a6953
21 changed files with 96 additions and 205 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/docs-ci.yaml vendored
View File

@ -29,4 +29,5 @@ jobs:
mkdocs-material- mkdocs-material-
- run: pip install mkdocs-material - run: pip install mkdocs-material
- run: pip install "mkdocs-material[imaging]" - run: pip install "mkdocs-material[imaging]"
- run: pip install mkdocs-glightbox
- run: mkdocs gh-deploy -f docs/mkdocs.yml --force - run: mkdocs gh-deploy -f docs/mkdocs.yml --force

2
docs/docs/core-abilities/index.md
View File

@ -43,7 +43,7 @@ We use [tiktoken](https://github.com/openai/tiktoken) to tokenize the patches af
#### Example #### Example
<kbd><img src=https://codium.ai/images/git_patch_logic.png width="768"></kbd> ![Core Abilities](https://codium.ai/images/git_patch_logic.png){width=768}
## YAML Prompting ## YAML Prompting
TBD TBD

9
docs/docs/css/custom.css
View File

@ -16,3 +16,12 @@
font-size: 20px; font-size: 20px;
margin-left: 0px !important; margin-left: 0px !important;
} }
.md-content img {
border-width: 1px;
border-style: solid;
border-color: black;
outline-width: 3px;
outline-style: solid;
outline-color: darkgray;
}

90
docs/docs/index.md
View File

@ -47,83 +47,25 @@ PR-Agent offers extensive pull request functionalities across various git provid
## Example results ## Example results
<hr> #### [/describe](https://github.com/Codium-ai/pr-agent/pull/530)
<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/describe</a></h4> <figure markdown="1">
<div align="center"> ![/describe](https://www.codium.ai/images/pr_agent/describe_new_short_main.png){width=512}
<p float="center"> </figure>
<img src="https://www.codium.ai/images/pr_agent/describe_new_short_main.png" width="512">
</p>
</div>
<hr>
<h4><a href="https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099151">/review</a></h4> #### [/review](https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099151)
<div align="center"> <figure markdown="1">
<p float="center"> ![/review](https://www.codium.ai/images/pr_agent/review_new_short_main.png){width=512}
<kbd> </figure>
<img src="https://www.codium.ai/images/pr_agent/review_new_short_main.png" width="512">
</kbd>
</p>
</div>
<hr>
<h4><a href="https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099159">/improve</a></h4> #### [/improve](https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099159)
<div align="center"> <figure markdown="1">
<p float="center"> ![/improve](https://www.codium.ai/images/pr_agent/improve_new_short_main.png){width=512}
<kbd> </figure>
<img src="https://www.codium.ai/images/pr_agent/improve_new_short_main.png" width="512">
</kbd>
</p>
</div>
<hr>
<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/generate_labels</a></h4>
<div align="center">
<p float="center">
<kbd><img src="https://www.codium.ai/images/pr_agent/geneare_custom_labels_main_short.png" width="300"></kbd>
</p>
</div>
[//]: # (<h4><a href="https://github.com/Codium-ai/pr-agent/pull/78#issuecomment-1639739496">/reflect_and_review:</a></h4>)
[//]: # (<div align="center">)
[//]: # (<p float="center">)
[//]: # (<img src="https://www.codium.ai/images/reflect_and_review.gif" width="800">)
[//]: # (</p>)
[//]: # (</div>)
[//]: # (<h4><a href="https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695020538">/ask:</a></h4>)
[//]: # (<div align="center">)
[//]: # (<p float="center">)
[//]: # (<img src="https://www.codium.ai/images/ask-2.gif" width="800">)
[//]: # (</p>)
[//]: # (</div>)
[//]: # (<h4><a href="https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695024952">/improve:</a></h4>)
[//]: # (<div align="center">)
[//]: # (<p float="center">)
[//]: # (<img src="https://www.codium.ai/images/improve-2.gif" width="800">)
[//]: # (</p>)
[//]: # (</div>)
<div align="left">
</div>
<hr>
#### [/generate_labels](https://github.com/Codium-ai/pr-agent/pull/530)
<figure markdown="1">
![/generate_labels](https://www.codium.ai/images/pr_agent/geneare_custom_labels_main_short.png){width=300}
</figure>
## How it works ## How it works

16
docs/docs/installation/pr_agent_pro.md
View File

@ -7,9 +7,7 @@ See [here](https://pr-agent-docs.codium.ai/#pr-agent-pro) for more details about
Interested parties can subscribe to PR-Agent Pro through the following [link](https://www.codium.ai/pricing/). Interested parties can subscribe to PR-Agent Pro through the following [link](https://www.codium.ai/pricing/).
After subscribing, you are granted the ability to easily install the application across any of your repositories. After subscribing, you are granted the ability to easily install the application across any of your repositories.
<a href="https://codium.ai/images/pr_agent/pr_agent_pro_install.png"> ![PR Agent Pro](https://codium.ai/images/pr_agent/pr_agent_pro_install.png){width=468}
<img src="https://codium.ai/images/pr_agent/pr_agent_pro_install.png" width="468">
</a>
Each user who wants to use PR-Agent pro needs to buy a seat. Each user who wants to use PR-Agent pro needs to buy a seat.
Initially, CodiumAI offers a two-week trial period at no cost, after which continued access requires each user to secure a personal seat. Initially, CodiumAI offers a two-week trial period at no cost, after which continued access requires each user to secure a personal seat.
@ -27,7 +25,9 @@ Since GitLab platform does not support apps, installing PR-Agent Pro for GitLab
Acquire a personal, project or group level access token. Enable the “api” scope in order to allow PR-Agent to read pull requests, comment and respond to requests. Acquire a personal, project or group level access token. Enable the “api” scope in order to allow PR-Agent to read pull requests, comment and respond to requests.
<kbd><img src=https://www.codium.ai/images/pr_agent/gitlab_pro_pat.png></kbd> <figure markdown="1">
![Step 1](https://www.codium.ai/images/pr_agent/gitlab_pro_pat.png){width=750}
</figure>
Store the token in a safe place, you won’t be able to access it again after it was generated. Store the token in a safe place, you won’t be able to access it again after it was generated.
@ -42,7 +42,9 @@ You should see "Success!" displayed above the Submit button, and a shared secret
Install a webhook for your repository or groups, by clicking “webhooks” on the settings menu. Click the “Add new webhook” button. Install a webhook for your repository or groups, by clicking “webhooks” on the settings menu. Click the “Add new webhook” button.
<kbd><img src=https://www.codium.ai/images/pr_agent/gitlab_pro_add_webhook.png></kbd> <figure markdown="1">
![Step 3.1](https://www.codium.ai/images/pr_agent/gitlab_pro_add_webhook.png)
</figure>
In the webhook definition form, fill in the following fields: In the webhook definition form, fill in the following fields:
URL: https://pro.gitlab.pr-agent.codium.ai/webhook URL: https://pro.gitlab.pr-agent.codium.ai/webhook
@ -51,7 +53,9 @@ Secret token: Your CodiumAI key
Trigger: Check the ‘comments’ and ‘merge request events’ boxes. Trigger: Check the ‘comments’ and ‘merge request events’ boxes.
Enable SSL verification: Check the box. Enable SSL verification: Check the box.
<kbd><img src=https://www.codium.ai/images/pr_agent/gitlab_pro_webhooks.png></kbd> <figure markdown="1">
![Step 3.2](https://www.codium.ai/images/pr_agent/gitlab_pro_webhooks.png){width=750}
</figure>
### Step 4 ### Step 4

12
docs/docs/tools/analyze.md
View File

@ -11,13 +11,11 @@ It can be invoked manually by commenting on any PR:
## Example usage ## Example usage
An example [result](https://github.com/Codium-ai/pr-agent/pull/546#issuecomment-1868524805): An example [result](https://github.com/Codium-ai/pr-agent/pull/546#issuecomment-1868524805):
<kbd><img src=https://codium.ai/images/pr_agent/analyze_1.png width="768"></kbd> ![Analyze 1](https://codium.ai/images/pr_agent/analyze_1.png){width=750}
&rarr;
<kbd><img src=https://codium.ai/images/pr_agent/analyze_2.png width="768"></kbd> ![Analyze 2](https://codium.ai/images/pr_agent/analyze_2.png){width=750}
&rarr;
<kbd><img src=https://codium.ai/images/pr_agent/analyze_3.png width="768"></kbd> ![Analyze 3](https://codium.ai/images/pr_agent/analyze_3.png){width=750}
**Notes** **Notes**

6
docs/docs/tools/ask.md
View File

@ -7,9 +7,9 @@ It can be invoked manually by commenting on any PR:
``` ```
For example: For example:
<kbd><img src="https://codium.ai/images/pr_agent/ask_comment.png" width="768"></kbd> ![Ask Comment](https://codium.ai/images/pr_agent/ask_comment.png){width=768}
<kbd><img src="https://codium.ai/images/pr_agent/ask.png" width="768"></kbd> ![Ask](https://codium.ai/images/pr_agent/ask.png){width=768}
## Ask lines ## Ask lines
@ -18,6 +18,6 @@ You can run `/ask` on specific lines of code in the PR from the PR's diff view.
- To select multiple lines, click on the '+' sign of the first line and then hold and drag to select the rest of the lines. - To select multiple lines, click on the '+' sign of the first line and then hold and drag to select the rest of the lines.
- write `/ask "..."` in the comment box and press `Add single comment` button. - write `/ask "..."` in the comment box and press `Add single comment` button.
<kbd><img src="https://codium.ai/images/pr_agent/Ask_line.png" width="768"></kbd> ![Ask Line](https://codium.ai/images/pr_agent/Ask_line.png){width=768}
Note that the tool does not have "memory" of previous questions, and answers each question independently. Note that the tool does not have "memory" of previous questions, and answers each question independently.

9
docs/docs/tools/ci_feedback.md
View File

@ -8,13 +8,10 @@ The tool analyzes the failed checks and provides several feedbacks:
- Failure summary - Failure summary
- Relevant error logs - Relevant error logs
<kbd> ![Failed Check 1](https://www.codium.ai/images/pr_agent/failed_check1.png){width=768}
<img src="https://www.codium.ai/images/pr_agent/failed_check1.png" width="768">
</kbd>
&rarr; &rarr;
<kbd> ![Failed Check 2](https://www.codium.ai/images/pr_agent/failed_check2.png){width=768}
<img src="https://www.codium.ai/images/pr_agent/failed_check2.png" width="768">
</kbd>
___ ___

7
docs/docs/tools/custom_labels.md
View File

@ -9,11 +9,11 @@ For example:
If we wish to add detect changes to SQL queries in a given PR, we can add the following custom label along with its description: If we wish to add detect changes to SQL queries in a given PR, we can add the following custom label along with its description:
<kbd><img src=https://codium.ai/images/pr_agent/custom_labels_list.png width="768"></kbd> ![Custom labels list](https://codium.ai/images/pr_agent/custom_labels_list.png){width=768}
When running the `generate_labels` tool on a PR that includes changes in SQL queries, it will automatically suggest the custom label: When running the `generate_labels` tool on a PR that includes changes in SQL queries, it will automatically suggest the custom label:
<kbd><img src=https://codium.ai/images/pr_agent/custom_label_published.png width="768"></kbd> ![Custom labels published](https://codium.ai/images/pr_agent/custom_label_published.png){width=768}
Note that in addition to the dedicated tool `generate_labels`, the custom labels will also be used by the `describe` tool. Note that in addition to the dedicated tool `generate_labels`, the custom labels will also be used by the `describe` tool.
@ -36,7 +36,8 @@ b. Add/edit the custom labels. It should be formatted as follows:
* Label name: The name of the custom label. * Label name: The name of the custom label.
* Description: Start the description of with prefix `pr_agent:`, for example: `pr_agent: Description of when AI should suggest this label`.<br> * Description: Start the description of with prefix `pr_agent:`, for example: `pr_agent: Description of when AI should suggest this label`.<br>
The description should be comprehensive and detailed, indicating when to add the desired label. The description should be comprehensive and detailed, indicating when to add the desired label.
<kbd><img src=https://codium.ai/images/pr_agent/add_native_custom_labels.png width="880"></kbd>
![Add native custom labels](https://codium.ai/images/pr_agent/add_native_custom_labels.png){width=880}
c. Now the custom labels will be included in the `generate_labels` tool. c. Now the custom labels will be included in the `generate_labels` tool.

7
docs/docs/tools/custom_suggestions.md
View File

@ -43,10 +43,9 @@ The instructions above are just an example. We want to emphasize that the prompt
Results obtained with the prompt above: Results obtained with the prompt above:
<kbd><img src=https://codium.ai/images/pr_agent/custom_suggestions_prompt.png width="512"></kbd> ![Custom suggestions prompt](https://codium.ai/images/pr_agent/custom_suggestions_prompt.png){width=512}
&rarr;
<kbd><img src=https://codium.ai/images/pr_agent/custom_suggestions_result.png width="768"></kbd> ![Custom suggestions results](https://codium.ai/images/pr_agent/custom_suggestions_result.png){width=768}
## Configuration options ## Configuration options

49
docs/docs/tools/describe.md
View File

@ -7,17 +7,9 @@ The tool can be triggered automatically every time a new PR is [opened](../usage
``` ```
For example: For example:
<kbd> ![Describe comment](https://codium.ai/images/pr_agent/describe_comment.png){width=512}
<a href="https://codium.ai/images/pr_agent/describe_comment.png">
<img src="https://codium.ai/images/pr_agent/describe_comment.png" width="512">
</a>
</kbd>
<kbd> ![Describe New](https://codium.ai/images/pr_agent/describe_new.png){width=512}
<a href="https://codium.ai/images/pr_agent/describe_new.png">
<img src="https://codium.ai/images/pr_agent/describe_new.png" width="512">
</a>
</kbd>
@ -57,29 +49,17 @@ This feature enables you to copy the `changes walkthrough` table to the "Files c
To copy the `changes walkthrough` table to the "Files changed" tab, you can click on the checkbox that appears PR Description status message below the main PR Description: To copy the `changes walkthrough` table to the "Files changed" tab, you can click on the checkbox that appears PR Description status message below the main PR Description:
<kbd> ![Add table checkbox](https://codium.ai/images/pr_agent/add_table_checkbox.png){width=512}
<a href="https://codium.ai/images/pr_agent/add_table_checkbox.png">
<img src="https://codium.ai/images/pr_agent/add_table_checkbox.png" width="512">
</a>
</kbd>
If you prefer to have the file summaries appear in the "Files changed" tab on every PR, change the `pr_description.inline_file_summary` parameter in the configuration file, possible values are: If you prefer to have the file summaries appear in the "Files changed" tab on every PR, change the `pr_description.inline_file_summary` parameter in the configuration file, possible values are:
- `'table'`: File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab. - `'table'`: File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab.
<kbd> ![Diffview table](https://codium.ai/images/pr_agent/diffview-table.png){width=512}
<a href="https://codium.ai/images/pr_agent/diffview-table.png">
<img src="https://codium.ai/images/pr_agent/diffview-table.png" width="512">
</a>
</kbd>
- `true`: A collapsable file comment with changes title and a changes summary for each file in the PR. - `true`: A collapsable file comment with changes title and a changes summary for each file in the PR.
<kbd> ![Diffview changes](https://codium.ai/images/pr_agent/diffview_changes.png){width=512}
<a href="https://codium.ai/images/pr_agent/diffview_changes.png">
<img src="https://codium.ai/images/pr_agent/diffview_changes.png" width="512">
</a>
</kbd>
- `false` (`default`): File changes walkthrough will be added only to the "Conversation" tab. - `false` (`default`): File changes walkthrough will be added only to the "Conversation" tab.
@ -99,11 +79,7 @@ Now add/edit the custom labels. they should be formatted as follows:
* Description: Start the description of with prefix `pr_agent:`, for example: `pr_agent: Description of when AI should suggest this label`.<br> * Description: Start the description of with prefix `pr_agent:`, for example: `pr_agent: Description of when AI should suggest this label`.<br>
The description should be comprehensive and detailed, indicating when to add the desired label. For example: The description should be comprehensive and detailed, indicating when to add the desired label. For example:
<kbd> ![Add native custom labels](https://codium.ai/images/pr_agent/add_native_custom_labels.png){width=768}
<a href="https://codium.ai/images/pr_agent/add_native_custom_labels.png">
<img src="https://codium.ai/images/pr_agent/add_native_custom_labels.png" width="768">
</a>
</kbd>
### Markers template ### Markers template
@ -126,19 +102,12 @@ pr_agent:walkthrough
``` ```
The marker `pr_agent:type` will be replaced with the PR type, `pr_agent:summary` will be replaced with the PR summary, and `pr_agent:walkthrough` will be replaced with the PR walkthrough. The marker `pr_agent:type` will be replaced with the PR type, `pr_agent:summary` will be replaced with the PR summary, and `pr_agent:walkthrough` will be replaced with the PR walkthrough.
<kbd> ![Describe markers before](https://codium.ai/images/pr_agent/describe_markers_before.png){width=512}
<a href="https://codium.ai/images/pr_agent/describe_markers_before.png">
<img src="https://codium.ai/images/pr_agent/describe_markers_before.png" width="512">
</a>
</kbd>
&rarr; &rarr;
<kbd> ![Describe markers after](https://codium.ai/images/pr_agent/describe_markers_after.png){width=512}
<a href="https://codium.ai/images/pr_agent/describe_markers_after.png">
<img src="https://codium.ai/images/pr_agent/describe_markers_after.png" width="512">
</a>
</kbd>
**Configuration params**: **Configuration params**:

6
docs/docs/tools/documentation.md
View File

@ -7,11 +7,11 @@ It can be invoked manually by commenting on any PR:
``` ```
For example: For example:
<kbd><img src=https://codium.ai/images/pr_agent/docs_command.png width="768"></kbd> ![Docs command](https://codium.ai/images/pr_agent/docs_command.png){width=768}
<kbd><img src=https://codium.ai/images/pr_agent/docs_components.png width="768"></kbd> ![Docs component](https://codium.ai/images/pr_agent/docs_components.png){width=768}
<kbd><img src=https://codium.ai/images/pr_agent/docs_single_component.png width="768"></kbd> ![Docs single component](https://codium.ai/images/pr_agent/docs_single_component.png){width=768}
## Configuration options ## Configuration options
- `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`. - `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`.

14
docs/docs/tools/improve.md
View File

@ -9,20 +9,12 @@ The tool can be triggered automatically every time a new PR is [opened](../usage
The code suggestions can be presented as a single comment (via `pr_code_suggestions.summarize=true`): The code suggestions can be presented as a single comment (via `pr_code_suggestions.summarize=true`):
<kbd> ![code suggestions as comment](https://codium.ai/images/pr_agent/code_suggestions_as_comment.png){width=512}
<a href="https://codium.ai/images/pr_agent/code_suggestions_as_comment.png" target="_blank">
<img src="https://codium.ai/images/pr_agent/code_suggestions_as_comment.png" width="512">
</a>
</kbd>
Or as a separate commitable code comment for each suggestion: Or as a separate commitable code comment for each suggestion:
<kbd> ![imporove](https://codium.ai/images/pr_agent/improve.png){width=512}
<a href="https://codium.ai/images/pr_agent/improve.png" target="_blank">
<img src="https://codium.ai/images/pr_agent/improve.png" width="512">
</a>
</kbd>
Note that a single comment has a significantly smaller PR footprint. We recommend this mode for most cases. Note that a single comment has a significantly smaller PR footprint. We recommend this mode for most cases.
Also note that collapsible are not supported in _Bitbucket_. Hence, the suggestions are presented there as code comments. Also note that collapsible are not supported in _Bitbucket_. Hence, the suggestions are presented there as code comments.

36
docs/docs/tools/review.md
View File

@ -6,17 +6,9 @@ The tool can be triggered automatically every time a new PR is [opened](../usage
``` ```
For example: For example:
<kbd> ![review comment](https://codium.ai/images/pr_agent/review_comment.png){width=512}
<a href="https://codium.ai/images/pr_agent/review_comment.png">
<img src="https://codium.ai/images/pr_agent/review_comment.png" width="512">
</a>
</kbd>
<kbd> ![review](https://codium.ai/images/pr_agent/review_comment.png){width=512}
<a href="https://codium.ai/images/pr_agent/review3.png">
<img src="https://codium.ai/images/pr_agent/review3.png" width="512">
</a>
</kbd>
## Configuration options ## Configuration options
@ -70,11 +62,7 @@ For invoking the incremental mode, the following command can be used:
``` ```
Note that the incremental mode is only available for GitHub. Note that the incremental mode is only available for GitHub.
<kbd> ![incremental review](https://codium.ai/images/pr_agent/incremental_review_2.png){width=512}
<a href="https://codium.ai/images/pr_agent/incremental_review_2.png">
<img src="https://codium.ai/images/pr_agent/incremental_review_2.png" width="512">
</a>
</kbd>
### PR Reflection ### PR Reflection
@ -84,23 +72,11 @@ By invoking:
``` ```
The tool will first ask the author questions about the PR, and will guide the review based on their answers. The tool will first ask the author questions about the PR, and will guide the review based on their answers.
<kbd> ![reflection questions](https://codium.ai/images/pr_agent/reflection_questions.png){width=512}
<a href="https://codium.ai/images/pr_agent/reflection_questions.png">
<img src="https://codium.ai/images/pr_agent/reflection_questions.png" width="512">
</a>
</kbd>
<kbd> ![reflection answers](https://codium.ai/images/pr_agent/reflection_answers.png){width=512}
<a href="https://codium.ai/images/pr_agent/reflection_answers.png">
<img src="https://codium.ai/images/pr_agent/reflection_answers.png" width="512">
</a>
</kbd>
<kbd> ![reflection insights](https://codium.ai/images/pr_agent/reflection_insights.png){width=512}
<a href="https://codium.ai/images/pr_agent/reflection_insights.png">
<img src="https://codium.ai/images/pr_agent/reflection_insights.png" width="512">
</a>
</kbd>
## Usage Tips ## Usage Tips

12
docs/docs/tools/similar_code.md
View File

@ -5,7 +5,8 @@ For example:
`Global Search` for a method called `chat_completion`: `Global Search` for a method called `chat_completion`:
<kbd><img src=https://codium.ai/images/pr_agent/similar_code_global2.png width="768"></kbd> ![similar code global](https://codium.ai/images/pr_agent/similar_code_global2.png){width=768}
PR-Agent will examine the code component and will extract the most relevant keywords to search for similar code: PR-Agent will examine the code component and will extract the most relevant keywords to search for similar code:
@ -16,11 +17,12 @@ PR-Agent will examine the code component and will extract the most relevant keyw
Search result link example: Search result link example:
<kbd><img src=https://codium.ai/images/pr_agent/code_search_result_single.png width="768"></kbd> ![code search result single](https://codium.ai/images/pr_agent/code_search_result_single.png){width=768}
`Organization Search`: `Organization Search`:
<kbd><img src=https://codium.ai/images/pr_agent/similar_code_org.png width="768"></kbd> ![similar code org](https://codium.ai/images/pr_agent/similar_code_org.png){width=768}
## How to use ## How to use
@ -47,11 +49,11 @@ It can be invoked automatically from the analyze table, can be accessed by:
/analyze /analyze
``` ```
Choose the components you want to find similar code for, and click on the `similar` checkbox. Choose the components you want to find similar code for, and click on the `similar` checkbox.
<kbd><img src=https://codium.ai/images/pr_agent/analyze_similar.png width="768"></kbd> ![analyze similar](https://codium.ai/images/pr_agent/analyze_similar.png){width=768}
If you are looking to search for similar code in the organization's codebase, you can click on the `Organization` checkbox, and it will invoke a new search command just for the organization's codebase. If you are looking to search for similar code in the organization's codebase, you can click on the `Organization` checkbox, and it will invoke a new search command just for the organization's codebase.
<kbd><img src=https://codium.ai/images/pr_agent/similar_code_global.png width="768"></kbd> ![similar code global](https://codium.ai/images/pr_agent/similar_code_global.png){width=768}
## Configuration options ## Configuration options

6
docs/docs/tools/similar_issues.md
View File

@ -6,11 +6,11 @@ It can be invoked manually by commenting on any PR:
``` ```
For example: For example:
<kbd><img src=https://codium.ai/images/pr_agent/similar_issue_original_issue.png width="768"></kbd> ![similar_issue_original_issue](https://codium.ai/images/pr_agent/similar_issue_original_issue.png){width=768}
<kbd><img src=https://codium.ai/images/pr_agent/similar_issue_comment.png width="768"></kbd> ![similar_issue_comment](https://codium.ai/images/pr_agent/similar_issue_comment.png){width=768}
<kbd><img src=https://codium.ai/images/pr_agent/similar_issue.png width="768"></kbd> ![similar_issue](https://codium.ai/images/pr_agent/similar_issue.png){width=768}
Note that to perform retrieval, the `similar_issue` tool indexes all the repo previous issues (once). Note that to perform retrieval, the `similar_issue` tool indexes all the repo previous issues (once).

6
docs/docs/tools/test.md
View File

@ -10,11 +10,11 @@ To get a list of the components that changed in the PR, use the [`analyze`](./an
An example [result](https://github.com/Codium-ai/pr-agent/pull/598#issuecomment-1913679429): An example [result](https://github.com/Codium-ai/pr-agent/pull/598#issuecomment-1913679429):
<kbd><img src=https://codium.ai/images/pr_agent/test1.png width="704"></kbd> ![test1](https://codium.ai/images/pr_agent/test1.png){width=704}
<kbd><img src=https://codium.ai/images/pr_agent/test2.png width="768"></kbd> ![test2](https://codium.ai/images/pr_agent/test2.png){width=768}
<kbd><img src=https://codium.ai/images/pr_agent/test3.png width="768"></kbd> ![test3](https://codium.ai/images/pr_agent/test3.png){width=768}
**Notes** **Notes**
- Language that are currently supported by the tool: Python, Java, C++, JavaScript, TypeScript. - Language that are currently supported by the tool: Python, Java, C++, JavaScript, TypeScript.

5
docs/docs/tools/update_changelog.md
View File

@ -6,10 +6,9 @@ It can be invoked manually by commenting on any PR:
``` ```
For example: For example:
<kbd><img src=https://codium.ai/images/pr_agent/update_changelog_comment.png width="768"></kbd> ![update_changelog_comment](https://codium.ai/images/pr_agent/update_changelog_comment.png){width=768}
<kbd><img src=https://codium.ai/images/pr_agent/update_changelog.png width="768"></kbd>
![update_changelog](https://codium.ai/images/pr_agent/update_changelog.png){width=768}
## Configuration options ## Configuration options

2
docs/docs/usage-guide/configuration_options.md
View File

@ -16,7 +16,7 @@ In terms of precedence, wiki configurations will override local configurations,
Specifically for GitHub, with PR-Agent-Pro you can set configurations by creating a page called `.pr_agent.toml` in the [wiki](https://github.com/Codium-ai/pr-agent/wiki/pr_agent.toml) of the repo. Specifically for GitHub, with PR-Agent-Pro you can set configurations by creating a page called `.pr_agent.toml` in the [wiki](https://github.com/Codium-ai/pr-agent/wiki/pr_agent.toml) of the repo.
The advantage of this method is that it allows to set configurations without needing to commit new content to the repo - just edit the wiki page and **save**. The advantage of this method is that it allows to set configurations without needing to commit new content to the repo - just edit the wiki page and **save**.
<kbd><img src="https://codium.ai/images/pr_agent/wiki_configuration.png" width="512"></kbd> ![wiki_configuration](https://codium.ai/images/pr_agent/wiki_configuration.png){width=512}
Click [here](https://codium.ai/images/pr_agent/wiki_configuration_pr_agent.mp4) to see a short instructional video. We recommend surrounding the configuration content with triple-quotes, to allow better presentation when displayed in the wiki as markdown. Click [here](https://codium.ai/images/pr_agent/wiki_configuration_pr_agent.mp4) to see a short instructional video. We recommend surrounding the configuration content with triple-quotes, to allow better presentation when displayed in the wiki as markdown.
An example content: An example content:

4
docs/docs/usage-guide/mail_notifications.md
View File

@ -2,8 +2,8 @@
Unfortunately, it is not possible in GitHub to disable mail notifications from a specific user. Unfortunately, it is not possible in GitHub to disable mail notifications from a specific user.
If you are subscribed to notifications for a repo with PR-Agent, we recommend turning off notifications for PR comments, to avoid lengthy emails: If you are subscribed to notifications for a repo with PR-Agent, we recommend turning off notifications for PR comments, to avoid lengthy emails:
<kbd><img src="https://codium.ai/images/pr_agent/notifications.png" width="512"></kbd> ![notifications](https://codium.ai/images/pr_agent/notifications.png){width=512}
As an alternative, you can filter in your mail provider the notifications specifically from the PR-Agent bot, [see how](https://www.quora.com/How-can-you-filter-emails-for-specific-people-in-Gmail#:~:text=On%20the%20Filters%20and%20Blocked,the%20body%20of%20the%20email). As an alternative, you can filter in your mail provider the notifications specifically from the PR-Agent bot, [see how](https://www.quora.com/How-can-you-filter-emails-for-specific-people-in-Gmail#:~:text=On%20the%20Filters%20and%20Blocked,the%20body%20of%20the%20email).
<kbd><img src="https://codium.ai/images/pr_agent/filter_mail_notifications.png" width="512"></kbd> ![filter_mail_notifications](https://codium.ai/images/pr_agent/filter_mail_notifications.png){width=512}

2
docs/mkdocs.yml
View File

@ -77,6 +77,7 @@ theme:
plugins: plugins:
- social - social
- search - search
- glightbox
extra: extra:
generator: false generator: false
@ -112,6 +113,7 @@ markdown_extensions:
- pymdownx.details - pymdownx.details
- pymdownx.superfences - pymdownx.superfences
- pymdownx.mark - pymdownx.mark
- md_in_html
- attr_list - attr_list
- pymdownx.emoji: - pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_index: !!python/name:material.extensions.emoji.twemoji