Merge commit 'b8bcaf86f239661a24fc61ade5b953edfa64a3e3' into hl/flip_2_configs

Example usage

.github/workflows/docs-ci.yaml

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

README.md

@@ -10,7 +10,7 @@
 
 </picture>
 <br/>
-Making pull requests less painful with an AI agent
+CodiumAI PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedbacks and suggestions
 </div>
 
 [![GitHub license](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/Codium-ai/pr-agent/blob/main/LICENSE)
@@ -21,18 +21,31 @@ Making pull requests less painful with an AI agent
     </a>
 </div>
 
+### [Documentation](https://pr-agent-docs.codium.ai/)
+- See the [Installation Guide](https://pr-agent-docs.codium.ai/installation/) for instructions on installing PR-Agent on different platforms.
+
+- See the [Usage Guide](https://pr-agent-docs.codium.ai/usage-guide/) for instructions on running PR-Agent tools via different interfaces, such as CLI, PR Comments, or by automatically triggering them when a new PR is opened.
+
+- See the [Tools Guide](https://pr-agent-docs.codium.ai/tools/) for a detailed description of the different tools, and the available configurations for each tool.
+
+
 ## Table of Contents
 - [News and Updates](#news-and-updates)
 - [Overview](#overview)
 - [Example results](#example-results)
 - [Try it now](#try-it-now)
-- [Installation](#installation)
 - [PR-Agent Pro 💎](#pr-agent-pro-)
 - [How it works](#how-it-works)
 - [Why use PR-Agent?](#why-use-pr-agent)
   
 ## News and Updates
 
+### April 14, 2024
+You can now ask questions about images that appear in the comment, where the entire PR is considered as the context.
+see [here](https://pr-agent-docs.codium.ai/tools/ask/#ask-on-images) for more details.
+
+<kbd><img src="https://codium.ai/images/pr_agent/ask_images5.png" width="512"></kbd>
+
 ### March 24, 2024
 PR-Agent is now available for easy installation via [pip](https://pr-agent-docs.codium.ai/installation/locally/#using-pip-package).
 
@@ -63,14 +76,6 @@ If set to true, the tool will add a section that checks if the PR contains sever
 ## Overview
 <div style="text-align:left;">
 
-CodiumAI PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedbacks and suggestions
-
-- See the [Installation Guide](https://pr-agent-docs.codium.ai/installation/) for instructions on installing and running the tool on different git platforms.
-
-- See the [Usage Guide](https://pr-agent-docs.codium.ai/usage-guide/) 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](https://pr-agent-docs.codium.ai/tools/) for a detailed description of the different tools.
-
 Supported commands per platform:
 
 |       |                                                                                                                   | GitHub             | Gitlab             | Bitbucket          | Azure DevOps       |
@@ -136,7 +141,7 @@ ___
 \
 ‣ **CI Feedback 💎 ([`/checks ci_job`](https://pr-agent-docs.codium.ai/tools/ci_feedback/))**: Automatically generates feedback and analysis for a failed CI job.
 \
-‣ **Similar Code 💎 ([`/find_similar_component`](https://pr-agent-docs.codium.ai/tools/similar_code//))**: Retrieves the most similar code components from inside the organization's codebase, or from open-source code.
+‣ **Similar Code 💎 ([`/find_similar_component`](https://pr-agent-docs.codium.ai/tools/similar_code/))**: Retrieves the most similar code components from inside the organization's codebase, or from open-source code.
 ___
 
 ## Example results
@@ -235,32 +240,47 @@ Note that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, there
 
 ---
 
-## Installation
-To use your own version of PR-Agent, you first need to acquire two tokens:
+[//]: # (## Installation)
 
-1. An OpenAI key from [here](https://platform.openai.com/), with access to GPT-4.
-2. A GitHub personal access token (classic) with the repo scope.
+[//]: # (To use your own version of PR-Agent, you first need to acquire two tokens:)
 
-There are several ways to use PR-Agent:
+[//]: # ()
+[//]: # (1. An OpenAI key from [here]&#40;https://platform.openai.com/&#41;, with access to GPT-4.)
 
-**Locally**
-- [Using pip package](https://pr-agent-docs.codium.ai/installation/locally/#using-pip-package)
-- [Using Docker image](https://pr-agent-docs.codium.ai/installation/locally/#using-docker-image)
-- [Run from source](https://pr-agent-docs.codium.ai/installation/locally/#run-from-source)
+[//]: # (2. A GitHub personal access token &#40;classic&#41; with the repo scope.)
 
-**GitHub specific methods**
-- [Run as a GitHub Action](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-action)
-- [Run as a GitHub App](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-app)
+[//]: # ()
+[//]: # (There are several ways to use PR-Agent:)
 
-**GitLab specific methods**
-- [Run a GitLab webhook server](https://pr-agent-docs.codium.ai/installation/gitlab/)
+[//]: # ()
+[//]: # (**Locally**)
 
-**BitBucket specific methods**
-- [Run as a Bitbucket Pipeline](https://pr-agent-docs.codium.ai/installation/bitbucket/)
+[//]: # (- [Using pip package]&#40;https://pr-agent-docs.codium.ai/installation/locally/#using-pip-package&#41;)
+
+[//]: # (- [Using Docker image]&#40;https://pr-agent-docs.codium.ai/installation/locally/#using-docker-image&#41;)
+
+[//]: # (- [Run from source]&#40;https://pr-agent-docs.codium.ai/installation/locally/#run-from-source&#41;)
+
+[//]: # ()
+[//]: # (**GitHub specific methods**)
+
+[//]: # (- [Run as a GitHub Action]&#40;https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-action&#41;)
+
+[//]: # (- [Run as a GitHub App]&#40;https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-app&#41;)
+
+[//]: # ()
+[//]: # (**GitLab specific methods**)
+
+[//]: # (- [Run a GitLab webhook server]&#40;https://pr-agent-docs.codium.ai/installation/gitlab/&#41;)
+
+[//]: # ()
+[//]: # (**BitBucket specific methods**)
+
+[//]: # (- [Run as a Bitbucket Pipeline]&#40;https://pr-agent-docs.codium.ai/installation/bitbucket/&#41;)
 
 ## PR-Agent Pro 💎
 [PR-Agent Pro](https://www.codium.ai/pricing/) is a hosted version of PR-Agent, provided by CodiumAI. It is available for a monthly fee, and provides the following benefits:
-1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the PR-Agent app to your GitHub\BitBucket repo.
+1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the PR-Agent app to your GitHub\GitLab\BitBucket repo.
 2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention.
 3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities.
 4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. 

docker/Dockerfile.lambda

@@ -1,10 +1,10 @@
 FROM public.ecr.aws/lambda/python:3.10
 
 RUN yum update -y && \
-    yum install -y gcc python3-devel && \
+    yum install -y gcc python3-devel git && \
     yum clean all
 
-ADD pyproject.toml .
+ADD pyproject.toml requirements.txt .
 RUN pip install . && rm pyproject.toml
 RUN pip install mangum==0.17.0
 COPY pr_agent/ ${LAMBDA_TASK_ROOT}/pr_agent/

docs/README.md

@@ -1,15 +1 @@
-# To install:
-pip install mkdocs
-pip install mkdocs-material
-pip install mkdocs-material-extensions
-pip install "mkdocs-material[imaging]"
-
-# docs
-To run localy: `mkdocs serve`
-
-To expand and customize the theme: [Material MKDocs](https://squidfunk.github.io/mkdocs-material/)
-
-The deployment is managed on the gh-pages branches.
-After each merge to main the deplloyment will be taken care of by GH action automatically and the new version will be available at: [Docs](https://codium-ai.github.io/docs/)
-
-Github action is located in `.github/workflows/ci.yml` file.
+# [Visit Our Docs Portal](https://pr-agent-docs.codium.ai/)

docs/docs/core-abilities/index.md

@@ -43,7 +43,7 @@ We use [tiktoken](https://github.com/openai/tiktoken) to tokenize the patches af
 
 #### 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
 TBD

docs/docs/css/custom.css

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

docs/docs/index.md

@@ -19,20 +19,19 @@ PR-Agent offers extensive pull request functionalities across various git provid
 |       | ⮑ [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"} 💎                                 |   ✅    |   ✅    |   ✅        |      ✅      |
+|       | ⮑ [Inline file summary](https://pr-agent-docs.codium.ai/tools/describe/#inline-file-summary){:target="_blank"} 💎                                 |   ✅    |   ✅    |           |      ✅      |
 |       | Improve                                                                                                             |   ✅    |   ✅    |   ✅        |      ✅      |
 |       | ⮑ Extended                                                                                                          |   ✅    |   ✅    |   ✅        |      ✅      |
 |       | [Custom Suggestions](./tools/custom_suggestions.md){:target="_blank"} 💎                                               |   ✅    |   ✅    |   ✅        |      ✅      |
 |       | Reflect and Review                                                                                                  |   ✅    |   ✅    |   ✅        |      ✅      |
 |       | Update CHANGELOG.md                                                                                                 |   ✅    |   ✅    |   ✅        |      ️       |
 |       | Find Similar Issue                                                                                                  |   ✅    |        |             |      ️       |
-|       | [Add PR Documentation](./tools/documentation.md){:target="_blank"} 💎                                                  |   ✅    |   ✅    |   ✅        |      ✅      |
+|       | [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"} 💎                                                       |   ✅    |   ✅    |   ✅      |      ✅      |
+|       | [Analyze PR Components](./tools/analyze.md){:target="_blank"} 💎                                                       |   ✅    |   ✅    |       |      ✅      |
 |       |                                                                                                                     |        |        |            |      ️       |
 | USAGE | CLI                                                                                                                 |   ✅    |   ✅    |   ✅       |      ✅      |
-|       | App / webhook                                                                                                       |   ✅    |   ✅    |            |      ✅      |
-|       | Tagging bot                                                                                                         |   ✅    |        |            |      ✅      |
+|       | App / webhook                                                                                                       |   ✅    |   ✅    |    ✅        |      ✅      |
 |       | Actions                                                                                                             |   ✅    |        |            |      ️       |
 |       |                                                                                                                     |        |        |            |
 | CORE  | PR compression                                                                                                      |   ✅    |   ✅    |   ✅       |   ✅        |
@@ -46,86 +45,34 @@ PR-Agent offers extensive pull request functionalities across various git provid
 💎 marks a feature available only in [PR-Agent Pro](https://www.codium.ai/pricing/){:target="_blank"}
 
 
-## Example results
-<hr>
-<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/describe</a></h4>
-<div align="center">
-<p float="center">
-<img src="https://www.codium.ai/images/pr_agent/describe_new_short_main.png" width="512">
-</p>
-</div>
+## Example Results
 <hr>
 
-<h4><a href="https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099151">/review</a></h4>
-<div align="center">
-<p float="center">
-<kbd>
-<img src="https://www.codium.ai/images/pr_agent/review_new_short_main.png" width="512">
-</kbd>
-</p>
-</div>
+#### [/describe](https://github.com/Codium-ai/pr-agent/pull/530)
+<figure markdown="1">
+![/describe](https://www.codium.ai/images/pr_agent/describe_new_short_main.png){width=512}
+</figure>
 <hr>
 
-<h4><a href="https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099159">/improve</a></h4>
-<div align="center">
-<p float="center">
-<kbd>
-<img src="https://www.codium.ai/images/pr_agent/improve_new_short_main.png" width="512">
-</kbd>
-</p>
-</div>
+#### [/review](https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099151)
+<figure markdown="1">
+![/review](https://www.codium.ai/images/pr_agent/review_new_short_main.png){width=512}
+</figure>
 <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>
+#### [/improve](https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099159)
+<figure markdown="1">
+![/improve](https://www.codium.ai/images/pr_agent/improve_new_short_main.png){width=512}
+</figure>
 <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>
+<hr>
 
-## How it works
+## How it Works
 
 The following diagram illustrates PR-Agent tools and their flow:
 
@@ -139,21 +86,25 @@ Check out the [PR Compression strategy](core-abilities/index.md) page for more d
 
 [PR-Agent Pro](https://www.codium.ai/pricing/) is a hosted version of PR-Agent, provided by CodiumAI. It is available for a monthly fee, and provides the following benefits:
 
-1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the PR-Agent app to your GitHub\BitBucket repo.
+1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the PR-Agent app to your GitHub\GitLab\BitBucket repo.
 2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention.
 3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities.
 4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. It has the following additional tools and features:
-    - [**Analyze PR components**](./tools/analyze.md/)
-    - [**Custom Code Suggestions**](./tools/custom_suggestions.md/)
-    - [**Tests**](./tools/test.md/)
-    - [**PR documentation**](./tools/documentation.md/)
-    - [**CI feedback**](./tools/ci_feedback.md/)
-    - [**SOC2 compliance check**](./tools/review.md/#soc2-ticket-compliance)
-    - [**Custom labels**](./tools/describe.md/#handle-custom-labels-from-the-repos-labels-page)
-    - [**Global and wiki configuration**](./usage-guide/configuration_options.md/#wiki-configuration-file)
+    - (Tool): [**Analyze PR components**](./tools/analyze.md/)
+    - (Tool): [**Custom Code Suggestions**](./tools/custom_suggestions.md/)
+    - (Tool): [**Tests**](./tools/test.md/)
+    - (Tool): [**PR documentation**](./tools/documentation.md/)
+    - (Tool): [**Improve Component**](https://pr-agent-docs.codium.ai/tools/improve_component/)
+    - (Tool): [**Similar code search**](https://pr-agent-docs.codium.ai/tools/similar_code/)
+    - (Tool): [**CI feedback**](./tools/ci_feedback.md/)
+    - (Feature): [**Interactive triggering**](./usage-guide/automations_and_usage.md/#interactive-triggering)
+    - (Feature): [**SOC2 compliance check**](./tools/review.md/#soc2-ticket-compliance)
+    - (Feature): [**Custom labels**](./tools/describe.md/#handle-custom-labels-from-the-repos-labels-page)
+    - (Feature): [**Global and wiki configuration**](./usage-guide/configuration_options.md/#wiki-configuration-file)
+    - (Feature): [**Inline file summary**](https://pr-agent-docs.codium.ai/tools/describe/#inline-file-summary)
 
    
-## Data privacy
+## Data Privacy
 
 If you host PR-Agent with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here:
 https://openai.com/enterprise-privacy

docs/docs/installation/github.md

@@ -7,9 +7,11 @@ You can use our pre-built Github Action Docker image to run PR-Agent as a Github
 ```yaml
 on:
   pull_request:
+    types: [opened, reopened, ready_for_review]
   issue_comment:
 jobs:
   pr_agent_job:
+    if: ${{ github.event.sender.type != 'Bot' }}
     runs-on: ubuntu-latest
     permissions:
       issues: write
@@ -24,27 +26,14 @@ jobs:
           OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
-** if you want to pin your action to a specific release (v0.7 for example) for stability reasons, use:
+** if you want to pin your action to a specific release (v2.0 for example) for stability reasons, use:
 ```yaml
-on:
-  pull_request:
-  issue_comment:
-
-jobs:
-  pr_agent_job:
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-      pull-requests: write
-      contents: write
-    name: Run pr agent on every pull request, respond to user comments
+...
     steps:
       - name: PR Agent action step
         id: pragent
-        uses: Codium-ai/pr-agent@v0.7
-        env:
-          OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: Codium-ai/pr-agent@v2.0
+...
 ```
 2) Add the following secret to your repository under `Settings > Secrets and variables > Actions > New repository secret > Add secret`:
 
@@ -66,6 +55,7 @@ When you open your next PR, you should see a comment from `github-actions` bot w
         PR_REVIEWER.REQUIRE_TESTS_REVIEW: "false" # Disable tests review
         PR_CODE_SUGGESTIONS.NUM_CODE_SUGGESTIONS: 6 # Increase number of code suggestions
 ```
+See detailed usage instructions in the [USAGE GUIDE](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-action)
 
 ---
 
@@ -159,6 +149,9 @@ cp pr_agent/settings/.secrets_template.toml pr_agent/settings/.secrets.toml
 
 ## Deploy as a Lambda Function
 
+Note that since AWS Lambda env vars cannot have "." in the name, you can replace each "." in an env variable with "__".<br>
+For example: `GITHUB.WEBHOOK_SECRET` --> `GITHUB__WEBHOOK_SECRET`
+
 1. Follow steps 1-5 from [here](#run-as-a-github-app).
 2. Build a docker image that can be used as a lambda function
     ```shell
@@ -246,4 +239,4 @@ After you set up AWS CodeCommit using the instructions above, here is an example
 PYTHONPATH="/PATH/TO/PROJECTS/pr-agent" python pr_agent/cli.py \
   --pr_url https://us-east-1.console.aws.amazon.com/codesuite/codecommit/repositories/MY_REPO_NAME/pull-requests/321 \
   review
-```
+```

docs/docs/installation/index.md

@@ -1,6 +1,6 @@
 # Installation
 
-## self-hosted PR-Agent
+## Self-hosted PR-Agent
 If you choose to host you own PR-Agent, you first need to acquire two tokens:
 
 1. An OpenAI key from [here](https://platform.openai.com/api-keys), with access to GPT-4 (or a key for [other models](../usage-guide/additional_configurations.md/#changing-a-model), if you prefer).

docs/docs/installation/pr_agent_pro.md

@@ -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/). 
 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">
-<img src="https://codium.ai/images/pr_agent/pr_agent_pro_install.png" width="468">
-</a>
+![PR Agent Pro](https://codium.ai/images/pr_agent/pr_agent_pro_install.png){width=468}
 
 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.
@@ -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.
 
-<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.
 
@@ -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.
 
-<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:
 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.
 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
 

docs/docs/tools/analyze.md

@@ -1,7 +1,7 @@
 ## Overview
-The `analyze` tool combines static code analysis with LLM capabilities to provide a comprehensive analysis of the PR code changes.
+The `analyze` tool combines advanced static code analysis with LLM capabilities to provide a comprehensive analysis of the PR code changes.
 
-The tool scans the PR code changes, find the code components (methods, functions, classes) that changed, and summarizes the changes in each component.
+The tool scans the PR code changes, find the code components (methods, functions, classes) that changed, and enables to interactively generate tests, docs, code suggestions and similar code search for each component.
 
 It can be invoked manually by commenting on any PR:
 ```
@@ -9,16 +9,10 @@ It can be invoked manually by commenting on any PR:
 ```
 
 ## Example usage
-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>
-
-<kbd><img src=https://codium.ai/images/pr_agent/analyze_2.png width="768"></kbd>
-
-<kbd><img src=https://codium.ai/images/pr_agent/analyze_3.png width="768"></kbd>
-
+An example result:
 
+![Analyze 1](https://codium.ai/images/pr_agent/analyze_1.png){width=750}
 
 **Notes**
 
-- Language that are currently supported: Python, Java, C++, JavaScript, TypeScript.
+- Language that are currently supported: Python, Java, C++, JavaScript, TypeScript, C#.

docs/docs/tools/ask.md

@@ -7,9 +7,9 @@ It can be invoked manually by commenting on any PR:
 ```
 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=512}
 
-<kbd><img src="https://codium.ai/images/pr_agent/ask.png" width="768"></kbd>
+![Ask](https://codium.ai/images/pr_agent/ask.png){width=512}
 
 ## Ask lines
 
@@ -18,6 +18,41 @@ 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. 
 - 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=512}
 
 Note that the tool does not have "memory" of previous questions, and answers each question independently.
+
+## Ask on images
+
+You can also ask questions about images that appear in the comment, where the entire PR code will be used as context.
+<br>
+The basic syntax is:
+```
+/ask "..."
+
+[Image](https://real_link_to_image)
+```
+where `https://real_link_to_image` is the direct link to the image.
+
+Note that GitHub has a built-in mechanism of pasting images in comments. However, pasted image does not provide a direct link.
+To get a direct link to an image, we recommend using the following scheme:
+
+1) First, post a comment that contains **only** the image:
+
+![Ask image1](https://codium.ai/images/pr_agent/ask_images1.png){width=512}
+
+2) Quote reply to that comment:
+
+![Ask image2](https://codium.ai/images/pr_agent/ask_images2.png){width=512}
+
+3) In the screen opened, type the question below the image:
+
+![Ask image3](https://codium.ai/images/pr_agent/ask_images3.png){width=512}
+![Ask image4](https://codium.ai/images/pr_agent/ask_images4.png){width=512}
+
+4) Post the comment, and receive the answer:
+
+![Ask image5](https://codium.ai/images/pr_agent/ask_images5.png){width=512}
+
+
+See a full video tutorial [here](https://codium.ai/images/pr_agent/ask_image_video.mov)

docs/docs/tools/ci_feedback.md

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

docs/docs/tools/custom_labels.md

@@ -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:
 
-<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:
 
-<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.
 
@@ -36,7 +36,8 @@ b. Add/edit the custom labels. It should be formatted as follows:
 * 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>
 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.
 

docs/docs/tools/custom_suggestions.md

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

docs/docs/tools/describe.md

@@ -5,39 +5,59 @@ The tool can be triggered automatically every time a new PR is [opened](../usage
 ```
 /describe
 ```
-For example:
 
-<kbd>
-<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>
+## Example usage
 
-<kbd>
-<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>
+### Manual invocation
 
+Invoke the tool manually by commenting `/describe` on any PR:
 
-  
-## Configuration options
+![Describe comment](https://codium.ai/images/pr_agent/describe_comment.png){width=512}
 
-### General configurations
-To edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L46) related to the describe tool (`pr_description` section), use the following template:
+After ~30 seconds, the tool will generate a description for the PR:
+
+![Describe New](https://codium.ai/images/pr_agent/describe_new.png){width=512}
+
+If you want to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L46), add the relevant ones to the command:
 ```
 /describe --pr_description.some_config1=... --pr_description.some_config2=...
 ```
 
+### Automatic invocation
+
+To run the `describe` automatically when a PR is opened, define in a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/#wiki-configuration-file):
+```
+[github_app]
+pr_commands = [
+    "/describe",
+    ...
+]
+
+[pr_description]
+publish_labels = ...
+...
+
+```
+
+- The `pr_commands` lists commands that will be executed on every PR.
+- The `[pr_description]` section contains the configurations for the `describe` tool you want to edit.
+
+
+## Configuration options
+
+### General configurations
+
 !!! example "Possible configurations"
 
-    - `publish_labels`: if set to true, the tool will publish the labels to the PR. Default is true.
+    - `disable_publish_labels`: if set to true, the tool will not publish the labels to the PR. Default is false.
 
     - `publish_description_as_comment`: if set to true, the tool will publish the description as a comment to the PR. If false, it will overwrite the original description. Default is false.
 
+    - `publish_description_as_comment_persistent`: if set to true and `publish_description_as_comment` is true, the tool will publish the description as a persistent comment to the PR. Default is true.
+
     - `add_original_user_description`: if set to true, the tool will add the original user description to the generated description. Default is true.
 
-    - `keep_original_user_title`: if set to true, the tool will keep the original PR title, and won't change it. Default is true.
+    - `generate_ai_title`: if set to true, the tool will automatically generate a title for the PR. If false, it will keep the original title. Default is false.
 
     - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
 
@@ -45,7 +65,7 @@ To edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agen
 
     - `enable_pr_type`: if set to false, it will not show the `PR type` as a text value in the description content. Default is true.
 
-    - `final_update_message`: if set to true, it will add a comment message [`PR Description updated to latest commit...`](https://github.com/Codium-ai/pr-agent/pull/499#issuecomment-1837412176) after finishing calling `/describe`. Default is true.
+    - `disable_final_update_message`: if set to true, the tool will skip adding a comment message [`PR Description updated to latest commit...`](https://github.com/Codium-ai/pr-agent/pull/499#issuecomment-1837412176) after finishing calling `/describe`. Default is false.
 
     - `enable_semantic_files_types`: if set to true, "Changes walkthrough" section will be generated. Default is true.
     - `collapsible_file_list`: if set to true, the file list in the "Changes walkthrough" section will be collapsible. If set to "adaptive", the file list will be collapsible only if there are more than 8 files. Default is "adaptive".
@@ -57,55 +77,23 @@ 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:
 
-<kbd>
-<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>
+![Add table checkbox](https://codium.ai/images/pr_agent/add_table_checkbox.png){width=512}
 
 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.
 
-<kbd>
-<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>
+![Diffview table](https://codium.ai/images/pr_agent/diffview-table.png){width=512}
 
 - `true`: A collapsable file comment with changes title and a changes summary for each file in the PR.
 
-<kbd>
-<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>
+![Diffview changes](https://codium.ai/images/pr_agent/diffview_changes.png){width=512}
 
 - `false` (`default`): File changes walkthrough will be added only to the "Conversation" tab.
 
 **Note**: that this feature is currently available only for GitHub.
 
 
-### Handle custom labels from the Repo's labels page 💎
-
-You can control  the custom labels that will be suggested by the `describe` tool, from the repo's labels page:
-
-* GitHub : go to `https://github.com/{owner}/{repo}/labels` (or click on the "Labels" tab in the issues or PRs page)
-* GitLab : go to `https://gitlab.com/{owner}/{repo}/-/labels` (or click on "Manage" -> "Labels" on the left menu)
-
-Now add/edit the custom labels. they should be formatted as follows:
-
-* 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>
-
-The description should be comprehensive and detailed, indicating when to add the desired label. For example:
-<kbd>
-<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
 
 To enable markers, set `pr_description.use_description_markers=true`.
@@ -126,25 +114,55 @@ 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.
 
-<kbd>
-<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>
+![Describe markers before](https://codium.ai/images/pr_agent/describe_markers_before.png){width=512}
 
 &rarr;
 
-<kbd>
-<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>
+![Describe markers after](https://codium.ai/images/pr_agent/describe_markers_after.png){width=512}
+
 
 **Configuration params**:
 
 - `use_description_markers`: if set to true, the tool will use markers template. It replaces every marker of the form `pr_agent:marker_name` with the relevant content. Default is false.
 - `include_generated_by_header`: if set to true, the tool will add a dedicated header: 'Generated by PR Agent at ...' to any automatic content. Default is true.
 
+## Custom labels
+
+The default labels of the describe tool are quite generic, since they are meant to be used in any repo: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`].
+
+You can define custom labels that are relevant for your repo and use cases.
+Custom labels can be defined in a [configuration file](https://pr-agent-docs.codium.ai/tools/custom_labels/#configuration-options), or directly in the repo's [labels page](#handle-custom-labels-from-the-repos-labels-page).
+
+Examples for custom labels:
+
+  - `Main topic:performance` -  pr_agent:The main topic of this PR is performance
+  - `New endpoint` -  pr_agent:A new endpoint was added in this PR
+  - `SQL query` -  pr_agent:A new SQL query was added in this PR
+  - `Dockerfile changes` - pr_agent:The PR contains changes in the Dockerfile
+  - ...
+
+The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
+Note that Labels are not mutually exclusive, so you can add multiple label categories.
+<br>
+Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
+Each label description should be a **conditional statement**, that indicates if to add the label to the PR or not, according to the PR content.
+
+
+### Handle custom labels from the Repo's labels page 💎
+
+You can control  the custom labels that will be suggested by the `describe` tool, from the repo's labels page:
+
+* GitHub : go to `https://github.com/{owner}/{repo}/labels` (or click on the "Labels" tab in the issues or PRs page)
+* GitLab : go to `https://gitlab.com/{owner}/{repo}/-/labels` (or click on "Manage" -> "Labels" on the left menu)
+
+Now add/edit the custom labels. they should be formatted as follows:
+
+* 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>
+
+The description should be comprehensive and detailed, indicating when to add the desired label. For example:
+![Add native custom labels](https://codium.ai/images/pr_agent/add_native_custom_labels.png){width=768}
+
 
 ## Usage Tips
 
@@ -173,20 +191,3 @@ The marker `pr_agent:type` will be replaced with the PR type, `pr_agent:summary`
           * `walkthrough`: the PR walkthrough.
 
     - Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.
-
-!!! tip "Custom labels"
-
-    The default labels of the describe tool are quite generic, since they are meant to be used in any repo: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`].
-    
-    If you specify [custom labels](#handle-custom-labels-from-the-repos-labels-page) in the repo's labels page, you can get tailored labels for your use cases.
-    Examples for custom labels:
-
-      - `Main topic:performance` -  pr_agent:The main topic of this PR is performance
-      - `New endpoint` -  pr_agent:A new endpoint was added in this PR
-      - `SQL query` -  pr_agent:A new SQL query was added in this PR
-      - `Dockerfile changes` - pr_agent:The PR contains changes in the Dockerfile
-      - ...
-    
-    The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
-    Note that Labels are not mutually exclusive, so you can add multiple label categories.
-    <br>Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.

docs/docs/tools/documentation.md

@@ -7,11 +7,11 @@ It can be invoked manually by commenting on any PR:
 ```
 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
  - `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`.
@@ -19,6 +19,6 @@ For example:
 
 **Notes**
 
-- Language that are currently fully supported: Python, Java, C++, JavaScript, TypeScript.
+- Language that are currently fully supported: Python, Java, C++, JavaScript, TypeScript, C#.
 - For languages that are not fully supported, the tool will suggest documentation only for new components in the PR.
 - A previous version of the tool, that offered support only for new components, was deprecated.

docs/docs/tools/help.md

@@ -0,0 +1,17 @@
+## Overview
+The `help` tool provides a list of all the available tools and their descriptions.
+For PR-Agent Pro users, it also enables to trigger each tool by checking the relevant box.
+
+It can be invoked manually by commenting on any PR:
+```
+/help
+```
+
+## Example usage
+An example [result](https://github.com/Codium-ai/pr-agent/pull/546#issuecomment-1868524805):
+
+![Help 1](https://codium.ai/images/pr_agent/help1.png){width=750}
+
+→
+
+![Analyze 2](https://codium.ai/images/pr_agent/help2.png){width=750}

docs/docs/tools/improve.md

@@ -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`):
 
-<kbd>
-<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>
-
+![code suggestions as comment](https://codium.ai/images/pr_agent/code_suggestions_as_comment.png){width=512}
 
 Or as a separate commitable code comment for each suggestion:
 
-<kbd>
-<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>
+![imporove](https://codium.ai/images/pr_agent/improve.png){width=512}
+
 
 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.
@@ -80,7 +72,7 @@ To edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agen
     Examples for extra instructions:
     ```
     [pr_code_suggestions] # /improve #
-    extra_instructions="""
+    extra_instructions="""\
     Emphasize the following aspects:
     - Does the code logic cover relevant edge cases?
     - Is the code logic clear and easy to understand?

docs/docs/tools/improve_component.md

@@ -0,0 +1,24 @@
+## Overview
+The `improve_component` tool generates code suggestions for a specific code component that changed in the PR.
+it can be invoked manually by commenting on any PR:
+```
+/improve_component component_name
+```
+
+To get a list of the components that changed in the PR and choose the relevant component interactively, use the [`analyze`](./analyze.md) tool.
+
+
+Example result:
+
+![improve_component1](https://codium.ai/images/pr_agent/improve_component1.png){width=768}
+
+![improve_component2](https://codium.ai/images/pr_agent/improve_component2.png){width=768}
+
+**Notes**
+- Language that are currently supported by the tool: Python, Java, C++, JavaScript, TypeScript, C#.
+
+## Configuration options
+- `num_code_suggestions`: number of code suggestions to provide. Default is 4
+- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on ...".
+- `file`: in case there are several components with the same name, you can specify the relevant file.
+- `class_name`: in case there are several methods with the same name in the same file, you can specify the relevant class name.

docs/docs/tools/index.md

@@ -2,19 +2,21 @@
 
 Here is a list of PR-Agent tools, each with a dedicated page that explains how to use it:
 
-| Tool                                                                          | Description                                                                                                                                 |
-|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
-| **[PR Description (`/describe`](./describe.md))**                             | Automatically generating PR description - title, type, summary, code walkthrough and labels                                                 |
-| **[PR Review (`/review`](./review.md))**                                      | Adjustable feedback about the PR, possible issues, security concerns, review effort and more                                                |
-| **[Code Suggestions (`/improve`](./improve.md))**                             | Code suggestions for improving the PR                                                                                                       |
-| **[Question Answering (`/ask ...`](./ask.md))**                               | Answering free-text questions about the PR, or on specific code lines                                                                       |
-| **[Update Changelog (`/update_changelog`](./update_changelog.md))**           | Automatically updating the CHANGELOG.md file with the PR changes                                                                            |
-| **[Find Similar Issue (`/similar_issue`](./similar_issues.md))**              | Automatically retrieves and presents similar issues                                                                                         |
-| **💎 [Add Documentation (`/add_docs`](./documentation.md))**                  | Generates documentation to methods/functions/classes that changed in the PR                                                                 |
-| **💎 [Generate Custom Labels (`/generate_labels`](./custom_labels.md))** | Generates custom labels for the PR, based on specific guidelines defined by the user                                                        |
-| **💎 [Analyze (`/analyze`](./analyze.md))**                                   | Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component |
-| **💎 [Custom Suggestions (`/custom_suggestions`](./custom_suggestions.md))**  | Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user                      |
-| **💎 [Generate Tests (`/test component_name`](./test.md))**                   | Automatically generates unit tests for a selected component, based on the PR code changes                                                   |
-| **💎 [CI Feedback (`/checks ci_job`](./ci_feedback.md))**                     | Automatically generates feedback and analysis for a failed CI job                                                                           |
+| Tool                                                                                     | Description                                                                                                                                 |
+|------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
+| **[PR Description (`/describe`](./describe.md))**                                        | Automatically generating PR description - title, type, summary, code walkthrough and labels                                                 |
+| **[PR Review (`/review`](./review.md))**                                                 | Adjustable feedback about the PR, possible issues, security concerns, review effort and more                                                |
+| **[Code Suggestions (`/improve`](./improve.md))**                                        | Code suggestions for improving the PR                                                                                                       |
+| **[Question Answering (`/ask ...`](./ask.md))**                                          | Answering free-text questions about the PR, or on specific code lines                                                                       |
+| **[Update Changelog (`/update_changelog`](./update_changelog.md))**                      | Automatically updating the CHANGELOG.md file with the PR changes                                                                            |
+| **[Find Similar Issue (`/similar_issue`](./similar_issues.md))**                         | Automatically retrieves and presents similar issues                                                                                         |
+| **[Help (`/help`](./help.md))**                                                         | Provides a list of all the available tools. Also enables to trigger them interactively (💎)                                                 |
+| **💎 [Add Documentation (`/add_docs`](./documentation.md))**                             | Generates documentation to methods/functions/classes that changed in the PR                                                                 |
+| **💎 [Generate Custom Labels (`/generate_labels`](./custom_labels.md))**                 | Generates custom labels for the PR, based on specific guidelines defined by the user                                                        |
+| **💎 [Analyze (`/analyze`](./analyze.md))**                                              | Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component |
+| **💎 [Custom Suggestions (`/custom_suggestions`](./custom_suggestions.md))**             | Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user                      |
+| **💎 [Generate Tests (`/test component_name`](./test.md))**                              | Automatically generates unit tests for a selected component, based on the PR code changes                                                   |
+| **💎 [Improve Component (`/improve_component component_name`](./improve_component.md))** | Generates code suggestions for a specific code component that changed in the PR                                                             |
+| **💎 [CI Feedback (`/checks ci_job`](./ci_feedback.md))**                                | Automatically generates feedback and analysis for a failed CI job                                                                           |
 
 Note that the tools marked with 💎 are available only for PR-Agent Pro users.

docs/docs/tools/review.md

@@ -6,17 +6,9 @@ The tool can be triggered automatically every time a new PR is [opened](../usage
 ```
 For example:
 
-<kbd>
-<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>
+![review comment](https://codium.ai/images/pr_agent/review_comment.png){width=512}
 
-<kbd>
-<a href="https://codium.ai/images/pr_agent/review3.png">
-<img src="https://codium.ai/images/pr_agent/review3.png" width="512">
-</a>
-</kbd>
+![review](https://codium.ai/images/pr_agent/review3.png){width=512}
 
 
 ## 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.
 
-<kbd>
-<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>
+![incremental review](https://codium.ai/images/pr_agent/incremental_review_2.png){width=512}
 
 ### 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.
 
-<kbd>
-<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>
+![reflection questions](https://codium.ai/images/pr_agent/reflection_questions.png){width=512}
 
-<kbd>
-<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>
+![reflection answers](https://codium.ai/images/pr_agent/reflection_answers.png){width=512}
 
-<kbd>
-<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>
+![reflection insights](https://codium.ai/images/pr_agent/reflection_insights.png){width=512}
 
 
 ## Usage Tips
@@ -148,8 +124,8 @@ The tool will first ask the author questions about the PR, and will guide the re
     
     Examples for extra instructions:
     ```
-    [pr_reviewer] # /review #
-    extra_instructions="""
+    [pr_reviewer]
+    extra_instructions="""\
     In the code feedback section, emphasize the following:
     - Does the code logic cover relevant edge cases?
     - Is the code logic clear and easy to understand?

docs/docs/tools/similar_code.md

@@ -5,7 +5,8 @@ For example:
 
 `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:
 
@@ -16,11 +17,12 @@ PR-Agent will examine the code component and will extract the most relevant keyw
 
 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`:
 
-<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
@@ -47,11 +49,11 @@ It can be invoked automatically from the analyze table, can be accessed by:
 /analyze
 ```
 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. 
 
-<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

docs/docs/tools/similar_issues.md

@@ -6,11 +6,11 @@ It can be invoked manually by commenting on any PR:
 ```
 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).
 

docs/docs/tools/test.md

@@ -5,19 +5,19 @@ It can be invoked manually by commenting on any PR:
 /test component_name
 ```
 where 'component_name' is the name of a specific component in the PR.
-To get a list of the components that changed in the PR, use the [`analyze`](./analyze.md) tool.
+To get a list of the components that changed in the PR and choose the relevant component interactively, use the [`analyze`](./analyze.md) tool.
 
 
 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**
-- 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, C#.
 
 
 ## Configuration options

docs/docs/tools/update_changelog.md

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

docs/docs/usage-guide/additional_configurations.md

@@ -7,10 +7,10 @@ To ignore files or directories, edit the **[ignore.toml](https://github.com/Codi
  - `IGNORE.GLOB`
  - `IGNORE.REGEX`
 
-For example, to ignore python files in a PR with online usage, comment on a PR:
+For example, to ignore Python files in a PR with online usage, comment on a PR:
 `/review --ignore.glob=['*.py']`
 
-To ignore python files in all PRs, set in a configuration file:
+To ignore Python files in all PRs, set in a configuration file:
 ```
 [ignore]
 glob = ['*.py']
@@ -26,13 +26,13 @@ All PR-Agent tools have a parameter called `extra_instructions`, that enables to
 ## Working with large PRs
 
 The default mode of CodiumAI is to have a single call per tool, using GPT-4, which has a token limit of 8000 tokens.
-This mode provide a very good speed-quality-cost tradeoff, and can handle most PRs successfully.
+This mode provides a very good speed-quality-cost tradeoff, and can handle most PRs successfully.
 When the PR is above the token limit, it employs a [PR Compression strategy](../core-abilities/index.md).
 
-However, for very large PRs, or in case you want to emphasize quality over speed and cost, there are 2 possible solutions:
+However, for very large PRs, or in case you want to emphasize quality over speed and cost, there are two possible solutions:
 1) [Use a model](https://codium-ai.github.io/Docs-PR-Agent/usage-guide/#changing-a-model) with larger context, like GPT-32K, or claude-100K. This solution will be applicable for all the tools.
 2) For the `/improve` tool, there is an ['extended' mode](https://codium-ai.github.io/Docs-PR-Agent/tools/#improve) (`/improve --extended`),
-which divides the PR to chunks, and process each chunk separately. With this mode, regardless of the model, no compression will be done (but for large PRs, multiple model calls may occur)
+which divides the PR to chunks, and processes each chunk separately. With this mode, regardless of the model, no compression will be done (but for large PRs, multiple model calls may occur)
 
 
 ## Changing a model
@@ -79,6 +79,7 @@ MAX_TOKENS={
 
 [config] # in configuration.toml
 model = "ollama/llama2"
+model_turbo = "ollama/llama2"
 
 [ollama] # in .secrets.toml
 api_base = ... # the base url for your huggingface inference endpoint
@@ -101,6 +102,7 @@ MAX_TOKENS={
 }
 [config] # in configuration.toml
 model = "huggingface/meta-llama/Llama-2-7b-chat-hf"
+model_turbo = "huggingface/meta-llama/Llama-2-7b-chat-hf"
 
 [huggingface] # in .secrets.toml
 key = ... # your huggingface api key
@@ -114,13 +116,14 @@ To use Llama2 model with Replicate, for example, set:
 ```
 [config] # in configuration.toml
 model = "replicate/llama-2-70b-chat:2c1608e18606fad2812020dc541930f2d0495ce32eee50074220b87300bc16e1"
+model_turbo = "replicate/llama-2-70b-chat:2c1608e18606fad2812020dc541930f2d0495ce32eee50074220b87300bc16e1"
 [replicate] # in .secrets.toml
 key = ...
 ```
 (you can obtain a Llama2 key from [here](https://replicate.com/replicate/llama-2-70b-chat/api))
 
 
-Also review the [AiHandler](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/algo/ai_handler.py) file for instruction how to set keys for other models.
+Also, review the [AiHandler](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/algo/ai_handler.py) file for instructions on how to set keys for other models.
 
 ### Vertex AI
 
@@ -129,6 +132,7 @@ To use Google's Vertex AI platform and its associated models (chat-bison/codecha
 ``` 
 [config] # in configuration.toml
 model = "vertex_ai/codechat-bison"
+model_turbo = "vertex_ai/codechat-bison"
 fallback_models="vertex_ai/codechat-bison"
 
 [vertexai] # in .secrets.toml
@@ -183,7 +187,7 @@ AWS session is automatically authenticated from your environment, but you can al
 
 ## Patch Extra Lines
 
-By default, around any change in your PR, git patch provides 3 lines of context above and below the change.
+By default, around any change in your PR, git patch provides three lines of context above and below the change.
 ```
 @@ -12,5 +12,5 @@ def func1():
  code line that already existed in the file...

docs/docs/usage-guide/automations_and_usage.md

@@ -50,6 +50,10 @@ Any configuration value in [configuration file](https://github.com/Codium-ai/pr-
 
 ## GitHub App
 
+!!! note "Configurations for PR-Agent Pro"
+    PR-Agent Pro for GitHub is an App, hosted by CodiumAI. So all the instructions below are relevant also for PR-Agent Pro users.
+    Same goes for [GitLab webhook](#gitlab-webhook) and [BitBucket App](#bitbucket-app) sections.
+
 ### GitHub app automatic tools when a new PR is opened
 
 The [github_app](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L108) section defines GitHub app specific configurations.  
@@ -58,8 +62,8 @@ The configuration parameter `pr_commands` defines the list of tools that will be
 ```
 [github_app]
 pr_commands = [
-    "/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true --pr_description.final_update_message=false",
-    "/review --pr_reviewer.num_code_suggestions=0 --pr_reviewer.final_update_message=false",
+    "/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true --pr_description.disable_final_update_message=true",
+    "/review --pr_reviewer.num_code_suggestions=0",
     "/improve",
 ]
 ```
@@ -99,13 +103,13 @@ The configuration parameter `push_commands` defines the list of tools that will
 handle_push_trigger = true
 push_commands = [
     "/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
-    "/review  --pr_reviewer.num_code_suggestions=0",
+    "/review  --pr_reviewer.num_code_suggestions=0 --pr_reviewer.disable_final_update_message=true",
 ]
 ```
 This means that when new code is pushed to the PR, the PR-Agent will run the `describe` and `review` tools, with the specified parameters.
 
 ## GitHub Action
-`GitHub Action` is a different way to trigger PR-Agent tools, and uses a different configuration mechanism than `GitHub App`.
+`GitHub Action` is a different way to trigger PR-Agent tools, and uses a different configuration mechanism than `GitHub App`.<br>
 You can configure settings for `GitHub Action` by adding environment variables under the env section in `.github/workflows/pr_agent.yml` file. 
 Specifically, start by setting the following environment variables:
 ```yaml
@@ -115,17 +119,23 @@ Specifically, start by setting the following environment variables:
         github_action_config.auto_review: "true" # enable\disable auto review
         github_action_config.auto_describe: "true" # enable\disable auto describe
         github_action_config.auto_improve: "true" # enable\disable auto improve
+        github_action_config.enable_output: "true" # enable\disable github actions output parameter
 ```
 `github_action_config.auto_review`, `github_action_config.auto_describe` and `github_action_config.auto_improve` are used to enable/disable automatic tools that run when a new PR is opened.
 If not set, the default configuration is for all three tools to run automatically when a new PR is opened.
 
-Note that you can give additional config parameters by adding environment variables to `.github/workflows/pr_agent.yml`, or by using a `.pr_agent.toml` file in the root of your repo, similar to the GitHub App usage.
+`github_action_config.enable_output` are used to enable/disable github actions [output parameter](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputs-for-docker-container-and-javascript-actions) (default is `true`). 
+Review result is output as JSON to `steps.{step-id}.outputs.review` property.
+The JSON structure is equivalent to the yaml data structure defined in [pr_reviewer_prompts.toml](https://github.com/idubnori/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml).
 
-For example, you can set an environment variable: `pr_description.add_original_user_description=false`, or add a `.pr_agent.toml` file with the following content:
+Note that you can give additional config parameters by adding environment variables to `.github/workflows/pr_agent.yml`, or by using a `.pr_agent.toml` [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/#global-configuration-file) in the root of your repo
+
+For example, you can set an environment variable: `pr_description.publish_labels=false`, or add a `.pr_agent.toml` file with the following content:
 ```
 [pr_description]
-add_original_user_description = false
+publish_labels = false
 ```
+to prevent PR-Agent from publishing labels when running the `describe` tool.
 
 ## GitLab Webhook
 After setting up a GitLab webhook, to control which commands will run automatically when a new PR is opened, you can set the `pr_commands` parameter in the configuration file, similar to the GitHub App:
@@ -153,11 +163,11 @@ Each time you invoke a `/review` tool, it will use inline code comments.
 
 ### BitBucket Self-Hosted App automatic tools
 
-to control which commands will run automatically when a new PR is opened, you can set the `pr_commands` parameter in the configuration file:
+To control which commands will run automatically when a new PR is opened, you can set the `pr_commands` parameter in the configuration file:
 Specifically, set the following values:
 
-[bitbucket_app]
 ```
+[bitbucket_app]
 pr_commands = [
     "/review --pr_reviewer.num_code_suggestions=0",
     "/improve --pr_code_suggestions.summarize=false",
@@ -196,4 +206,4 @@ pr_commands = [
     "/review --pr_reviewer.num_code_suggestions=0",
     "/improve",
 ]
-```
+```

docs/docs/usage-guide/configuration_options.md

@@ -16,13 +16,13 @@ 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. 
 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.
 An example content:
 
 ```
-[pr_description] # /describe #
+[pr_description]
 keep_original_user_title=false
 ```
 

docs/docs/usage-guide/index.md

@@ -1,8 +1,10 @@
 # Usage guide
 
+This page provides a detailed guide on how to use PR-Agent. It includes information on how to adjust PR-Agent configurations, define which tools will run automatically, manage mail notifications, and other advanced configurations.
+
+
 - [Introduction](./introduction.md)
 - [Configuration Options](./configuration_options.md)
-- [Managing Mail Notifications](./mail_notifications.md)
 - [Usage and Automation](./automations_and_usage.md)
     - [Local Repo (CLI)](./automations_and_usage.md#local-repo-cli)
     - [Online Usage](./automations_and_usage.md#online-usage)
@@ -11,6 +13,7 @@
     - [GitLab Webhook](./automations_and_usage.md#gitlab-webhook)
     - [BitBucket App](./automations_and_usage.md#bitbucket-app)
     - [Azure DevOps Provider](./automations_and_usage.md#azure-devops-provider)
+- [Managing Mail Notifications](./mail_notifications.md)
 - [Additional Configurations Walkthrough](./additional_configurations.md)
     - [Ignoring files from analysis](./additional_configurations.md#ignoring-files-from-analysis)
     - [Extra instructions](./additional_configurations.md#extra-instructions)

docs/docs/usage-guide/mail_notifications.md

@@ -2,8 +2,17 @@
 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:
 
-<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).
 
-<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}
+
+
+Another option to reduce the mail overload, yet still receive notifications on PR-Agent tools, is to disable the help collapsible section in PR-Agent bot comments. 
+This can done by setting `enable_help_text=false` for the relevant tool in the configuration file.
+For example, to disable the help text for the `pr_reviewer` tool, set:
+```
+[pr_reviewer]
+enable_help_text = false
+```

docs/mkdocs.yml

@@ -1,4 +1,6 @@
-site_name: PR-Agent
+site_name: PR-Agent Documentation 
+repo_url: https://github.com/Codium-ai/pr-agent
+repo_name: Codium-ai/pr-agent
 
 nav: 
   - Overview: 'index.md'
@@ -14,7 +16,7 @@ nav:
     - 'usage-guide/index.md'
     - Introduction: 'usage-guide/introduction.md'
     - Configuration Options: 'usage-guide/configuration_options.md'
-    - Managing email notifications: 'usage-guide/mail_notifications.md'
+    - Managing Mail Notifications: 'usage-guide/mail_notifications.md'
     - Usage and Automation: 'usage-guide/automations_and_usage.md'
     - Additional Configurations: 'usage-guide/additional_configurations.md'
   - Tools: 
@@ -25,8 +27,10 @@ nav:
     - Ask: 'tools/ask.md'
     - Update Changelog: 'tools/update_changelog.md'
     - Similar Issues: 'tools/similar_issues.md'
+    - Help: 'tools/help.md'
     - 💎 Analyze: 'tools/analyze.md'
     - 💎 Test: 'tools/test.md'
+    - 💎 Improve Component: 'tools/improve_component.md'
     - 💎 Documentation: 'tools/documentation.md'
     - 💎 Custom Labels: 'tools/custom_labels.md'
     - 💎 Custom Suggestions: 'tools/custom_suggestions.md'
@@ -38,6 +42,8 @@ theme:
   logo: assets/logo.svg
   favicon: assets/favicon.ico
   name: material
+  icon:
+    repo: fontawesome/brands/github
   features:
     - navigation.tabs
     - navigation.expand
@@ -77,6 +83,7 @@ theme:
 plugins:
   - social
   - search
+  - glightbox
 
 extra:
   generator: false
@@ -94,7 +101,7 @@ extra:
     - icon: fontawesome/brands/instagram
       link: https://www.instagram.com/codiumai/
   analytics:
-    provider: google
+    provider: custom
     property: ${{ secrets.GOOGLE_ANALYTICS_ID }}
 
 extra_css:
@@ -112,10 +119,11 @@ markdown_extensions:
   - pymdownx.details
   - pymdownx.superfences
   - pymdownx.mark
+  - md_in_html
   - attr_list
   - pymdownx.emoji:
       emoji_index: !!python/name:material.extensions.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - toc:
       title: On this page
       toc_depth: 3

docs/overrides/main.html

@@ -0,0 +1,10 @@
+{% extends "base.html" %}
+
+{% block scripts %}
+  {{ super() }}
+  
+    <!-- Google Tag Manager (noscript) -->
+    <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-5C9KZBM3"
+    height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
+    <!-- End Google Tag Manager (noscript) -->
+{% endblock %}

docs/overrides/partials/integrations/analytics/custom.html

@@ -0,0 +1,7 @@
+<!-- Google Tag Manager -->
+<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+    new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+    j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+    'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+    })(window,document,'script','dataLayer','GTM-5C9KZBM3');</script>
+    <!-- End Google Tag Manager -->

pr_agent/agent/pr_agent.py

@@ -73,6 +73,9 @@ class PRAgent:
         args = update_settings_from_args(args)
 
         action = action.lstrip("/").lower()
+        if action not in command2class:
+            get_logger().debug(f"Unknown command: {action}")
+            return False
         with get_logger().contextualize(command=action):
             get_logger().info("PR-Agent request handler started", analytics=True)
             if action == "reflect_and_review":

pr_agent/algo/__init__.py

@@ -10,6 +10,9 @@ MAX_TOKENS = {
     'gpt-4-32k': 32000,
     'gpt-4-1106-preview': 128000, # 128K, but may be limited by config.max_model_tokens
     'gpt-4-0125-preview': 128000,  # 128K, but may be limited by config.max_model_tokens
+    'gpt-4-turbo-preview': 128000,  # 128K, but may be limited by config.max_model_tokens
+    'gpt-4-turbo-2024-04-09': 128000,  # 128K, but may be limited by config.max_model_tokens
+    'gpt-4-turbo': 128000,  # 128K, but may be limited by config.max_model_tokens
     'claude-instant-1': 100000,
     'claude-2': 100000,
     'command-nightly': 4096,

pr_agent/algo/ai_handlers/base_ai_handler.py

@@ -15,7 +15,7 @@ class BaseAiHandler(ABC):
         pass
 
     @abstractmethod   
-    async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2):
+    async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2, img_path: str = None):
         """
         This method should be implemented to return a chat completion from the AI model.
         Args:

pr_agent/algo/ai_handlers/litellm_ai_handler.py

@@ -1,5 +1,5 @@
 import os
-
+import requests
 import boto3
 import litellm
 import openai
@@ -61,6 +61,9 @@ class LiteLLMAIHandler(BaseAiHandler):
         if get_settings().get("HUGGINGFACE.API_BASE", None) and 'huggingface' in get_settings().config.model:
             litellm.api_base = get_settings().huggingface.api_base
             self.api_base = get_settings().huggingface.api_base
+        if get_settings().get("OLLAMA.API_BASE", None) :
+            litellm.api_base = get_settings().ollama.api_base
+            self.api_base = get_settings().ollama.api_base
         if get_settings().get("HUGGINGFACE.REPITITION_PENALTY", None):
             self.repetition_penalty = float(get_settings().huggingface.repetition_penalty)
         if get_settings().get("VERTEXAI.VERTEX_PROJECT", None):
@@ -99,13 +102,27 @@ class LiteLLMAIHandler(BaseAiHandler):
         retry=retry_if_exception_type((openai.APIError, openai.APIConnectionError, openai.Timeout)), # No retry on RateLimitError
         stop=stop_after_attempt(OPENAI_RETRIES)
     )
-    async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2):
+    async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2, img_path: str = None):
         try:
             resp, finish_reason = None, None
             deployment_id = self.deployment_id
             if self.azure:
                 model = 'azure/' + model
             messages = [{"role": "system", "content": system}, {"role": "user", "content": user}]
+            if img_path:
+                try:
+                    # check if the image link is alive
+                    r = requests.head(img_path, allow_redirects=True)
+                    if r.status_code == 404:
+                        error_msg = f"The image link is not [alive](img_path).\nPlease repost the original image as a comment, and send the question again with 'quote reply' (see [instructions](https://pr-agent-docs.codium.ai/tools/ask/#ask-on-images-using-the-pr-code-as-context))."
+                        get_logger().error(error_msg)
+                        return f"{error_msg}", "error"
+                except Exception as e:
+                    get_logger().error(f"Error fetching image: {img_path}", e)
+                    return f"Error fetching image: {img_path}", "error"
+                messages[1]["content"] = [{"type": "text", "text": messages[1]["content"]},
+                                          {"type": "image_url", "image_url": {"url": img_path}}]
+
             kwargs = {
                 "model": model,
                 "deployment_id": deployment_id,
@@ -150,4 +167,4 @@ class LiteLLMAIHandler(BaseAiHandler):
             if get_settings().config.verbosity_level >= 2:
                 get_logger().info(f"\nAI response:\n{resp}")
 
-        return resp, finish_reason
+        return resp, finish_reason

pr_agent/algo/pr_processing.py

@@ -9,7 +9,7 @@ from pr_agent.algo.git_patch_processing import convert_to_hunks_with_lines_numbe
 from pr_agent.algo.language_handler import sort_files_by_main_languages
 from pr_agent.algo.file_filter import filter_ignored
 from pr_agent.algo.token_handler import TokenHandler
-from pr_agent.algo.utils import get_max_tokens, ModelType
+from pr_agent.algo.utils import get_max_tokens, clip_tokens, ModelType
 from pr_agent.config_loader import get_settings
 from pr_agent.git_providers.git_provider import GitProvider
 from pr_agent.algo.types import EDIT_TYPE, FilePatchInfo
@@ -87,22 +87,34 @@ def get_pr_diff(git_provider: GitProvider, token_handler: TokenHandler, model: s
     # if we are over the limit, start pruning
     get_logger().info(f"Tokens: {total_tokens}, total tokens over limit: {get_max_tokens(model)}, "
                       f"pruning diff.")
-    patches_compressed, modified_file_names, deleted_file_names, added_file_names = \
+    patches_compressed, modified_file_names, deleted_file_names, added_file_names, total_tokens_new = \
         pr_generate_compressed_diff(pr_languages, token_handler, model, add_line_numbers_to_hunks)
 
+    # Insert additional information about added, modified, and deleted files if there is enough space
+    max_tokens = get_max_tokens(model) - OUTPUT_BUFFER_TOKENS_HARD_THRESHOLD
+    curr_token = total_tokens_new  # == token_handler.count_tokens(final_diff)+token_handler.prompt_tokens
     final_diff = "\n".join(patches_compressed)
-    if added_file_names:
+    delta_tokens = 10
+    if added_file_names and (max_tokens - curr_token) > delta_tokens:
         added_list_str = ADDED_FILES_ + "\n".join(added_file_names)
-        final_diff = final_diff + "\n\n" + added_list_str
-    if modified_file_names:
+        added_list_str = clip_tokens(added_list_str, max_tokens - curr_token)
+        if added_list_str:
+            final_diff = final_diff + "\n\n" + added_list_str
+            curr_token += token_handler.count_tokens(added_list_str) + 2
+    if modified_file_names and (max_tokens - curr_token) > delta_tokens:
         modified_list_str = MORE_MODIFIED_FILES_ + "\n".join(modified_file_names)
-        final_diff = final_diff + "\n\n" + modified_list_str
-    if deleted_file_names:
+        modified_list_str = clip_tokens(modified_list_str, max_tokens - curr_token)
+        if modified_list_str:
+            final_diff = final_diff + "\n\n" + modified_list_str
+            curr_token += token_handler.count_tokens(modified_list_str) + 2
+    if deleted_file_names and (max_tokens - curr_token) > delta_tokens:
         deleted_list_str = DELETED_FILES_ + "\n".join(deleted_file_names)
-        final_diff = final_diff + "\n\n" + deleted_list_str
+        deleted_list_str = clip_tokens(deleted_list_str, max_tokens - curr_token)
+        if deleted_list_str:
+            final_diff = final_diff + "\n\n" + deleted_list_str
     try:
         get_logger().debug(f"After pruning, added_list_str: {added_list_str}, modified_list_str: {modified_list_str}, "
-                          f"deleted_list_str: {deleted_list_str}")
+                           f"deleted_list_str: {deleted_list_str}")
     except Exception as e:
         pass
     return final_diff
@@ -149,7 +161,7 @@ def pr_generate_extended_diff(pr_languages: list,
 
 
 def pr_generate_compressed_diff(top_langs: list, token_handler: TokenHandler, model: str,
-                                convert_hunks_to_line_numbers: bool) -> Tuple[list, list, list, list]:
+                                convert_hunks_to_line_numbers: bool) -> Tuple[list, list, list, list, int]:
     """
     Generate a compressed diff string for a pull request, using diff minimization techniques to reduce the number of
     tokens used.
@@ -195,10 +207,11 @@ def pr_generate_compressed_diff(top_langs: list, token_handler: TokenHandler, mo
         patch = handle_patch_deletions(patch, original_file_content_str,
                                        new_file_content_str, file.filename, file.edit_type)
         if patch is None:
-            if not deleted_files_list:
-                total_tokens += token_handler.count_tokens(DELETED_FILES_)
-            deleted_files_list.append(file.filename)
-            total_tokens += token_handler.count_tokens(file.filename) + 1
+            # if not deleted_files_list:
+            #     total_tokens += token_handler.count_tokens(DELETED_FILES_)
+            if file.filename not in deleted_files_list:
+                deleted_files_list.append(file.filename)
+            # total_tokens += token_handler.count_tokens(file.filename) + 1
             continue
 
         if convert_hunks_to_line_numbers:
@@ -219,14 +232,17 @@ def pr_generate_compressed_diff(top_langs: list, token_handler: TokenHandler, mo
             if get_settings().config.verbosity_level >= 2:
                 get_logger().warning(f"Patch too large, minimizing it, {file.filename}")
             if file.edit_type == EDIT_TYPE.ADDED:
-                if not added_files_list:
-                    total_tokens += token_handler.count_tokens(ADDED_FILES_)
-                added_files_list.append(file.filename)
+                # if not added_files_list:
+                #     total_tokens += token_handler.count_tokens(ADDED_FILES_)
+                if file.filename not in added_files_list:
+                    added_files_list.append(file.filename)
+                # total_tokens += token_handler.count_tokens(file.filename) + 1
             else:
-                if not modified_files_list:
-                    total_tokens += token_handler.count_tokens(MORE_MODIFIED_FILES_)
-                modified_files_list.append(file.filename)
-                total_tokens += token_handler.count_tokens(file.filename) + 1
+                # if not modified_files_list:
+                #     total_tokens += token_handler.count_tokens(MORE_MODIFIED_FILES_)
+                if file.filename not in modified_files_list:
+                    modified_files_list.append(file.filename)
+                # total_tokens += token_handler.count_tokens(file.filename) + 1
             continue
 
         if patch:
@@ -239,7 +255,7 @@ def pr_generate_compressed_diff(top_langs: list, token_handler: TokenHandler, mo
             if get_settings().config.verbosity_level >= 2:
                 get_logger().info(f"Tokens: {total_tokens}, last filename: {file.filename}")
 
-    return patches, modified_files_list, deleted_files_list, added_files_list
+    return patches, modified_files_list, deleted_files_list, added_files_list, total_tokens
 
 
 async def retry_with_fallback_models(f: Callable, model_type: ModelType = ModelType.REGULAR):
@@ -382,4 +398,4 @@ def get_pr_multi_diffs(git_provider: GitProvider,
         final_diff = "\n".join(patches)
         final_diff_list.append(final_diff)
 
-    return final_diff_list
+    return final_diff_list

pr_agent/algo/token_handler.py

@@ -1,12 +1,25 @@
 from jinja2 import Environment, StrictUndefined
 from tiktoken import encoding_for_model, get_encoding
-
 from pr_agent.config_loader import get_settings
+from threading import Lock
 
 
-def get_token_encoder():
-    return encoding_for_model(get_settings().config.model) if "gpt" in get_settings().config.model else get_encoding(
-        "cl100k_base")
+class TokenEncoder:
+    _encoder_instance = None
+    _model = None
+    _lock = Lock()  # Create a lock object
+
+    @classmethod
+    def get_token_encoder(cls):
+        model = get_settings().config.model
+        if cls._encoder_instance is None or model != cls._model:  # Check without acquiring the lock for performance
+            with cls._lock:  # Lock acquisition to ensure thread safety
+                if cls._encoder_instance is None or model != cls._model:
+                    cls._model = model
+                    cls._encoder_instance = encoding_for_model(cls._model) if "gpt" in cls._model else get_encoding(
+                        "cl100k_base")
+        return cls._encoder_instance
+
 
 class TokenHandler:
     """
@@ -31,7 +44,7 @@ class TokenHandler:
         - system: The system string.
         - user: The user string.
         """
-        self.encoder = get_token_encoder()
+        self.encoder = TokenEncoder.get_token_encoder()
         if pr is not None:
             self.prompt_tokens = self._get_system_user_tokens(pr, self.encoder, vars, system, user)
 

pr_agent/algo/utils.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import difflib
 import json
+import os
 import re
 import textwrap
 from datetime import datetime
@@ -12,7 +13,7 @@ import yaml
 from starlette_context import context
 
 from pr_agent.algo import MAX_TOKENS
-from pr_agent.algo.token_handler import get_token_encoder
+from pr_agent.algo.token_handler import TokenEncoder
 from pr_agent.config_loader import get_settings, global_settings
 from pr_agent.algo.types import FilePatchInfo
 from pr_agent.log import get_logger
@@ -566,7 +567,7 @@ def clip_tokens(text: str, max_tokens: int, add_three_dots=True) -> str:
         return text
 
     try:
-        encoder = get_token_encoder()
+        encoder = TokenEncoder.get_token_encoder()
         num_input_tokens = len(encoder.encode(text))
         if num_input_tokens <= max_tokens:
             return text
@@ -575,7 +576,7 @@ def clip_tokens(text: str, max_tokens: int, add_three_dots=True) -> str:
         num_output_chars = int(chars_per_token * max_tokens)
         clipped_text = text[:num_output_chars]
         if add_three_dots:
-            clipped_text += "...(truncated)"
+            clipped_text += "\n...(truncated)"
         return clipped_text
     except Exception as e:
         get_logger().warning(f"Failed to clip tokens: {e}")
@@ -661,3 +662,15 @@ def find_line_number_of_relevant_line_in_file(diff_files: List[FilePatchInfo],
                             absolute_position = start2 + delta - 1
                             break
     return position, absolute_position
+
+def github_action_output(output_data: dict, key_name: str):
+    try:
+        if not get_settings().get('github_action_config.enable_output', False):
+            return
+        
+        key_data = output_data.get(key_name, {})
+        with open(os.environ['GITHUB_OUTPUT'], 'a') as fh:
+            print(f"{key_name}={json.dumps(key_data, indent=None, ensure_ascii=False)}", file=fh)
+    except Exception as e:
+        get_logger().error(f"Failed to write to GitHub Action output: {e}")
+    return

pr_agent/cli.py

@@ -52,8 +52,8 @@ def set_parser():
 
 def run_command(pr_url, command):
     # Preparing the command
-    run_command = f"--pr_url={pr_url} {command.lstrip('/')}"
-    args = set_parser().parse_args(run_command.split())
+    run_command_str = f"--pr_url={pr_url} {command.lstrip('/')}"
+    args = set_parser().parse_args(run_command_str.split())
 
     # Run the command. Feedback will appear in GitHub PR comments
     run(args=args)

pr_agent/git_providers/codecommit_provider.py

@@ -10,7 +10,7 @@ from ..algo.utils import load_large_diff
 from .git_provider import GitProvider
 from ..config_loader import get_settings
 from ..log import get_logger
-
+from pr_agent.algo.language_handler import is_valid_file
 
 class PullRequestCCMimic:
     """

pr_agent/git_providers/github_provider.py

@@ -229,7 +229,7 @@ class GithubProvider(GitProvider):
         self.publish_comment(pr_comment)
 
     def publish_comment(self, pr_comment: str, is_temporary: bool = False):
-        if is_temporary and not get_settings().config.publish_output_progress:
+        if is_temporary or not get_settings().config.publish_output_progress:
             get_logger().debug(f"Skipping publish_comment for temporary comment: {pr_comment}")
             return
 
@@ -745,22 +745,4 @@ class GithubProvider(GitProvider):
             return False
 
     def calc_pr_statistics(self, pull_request_data: dict):
-        try:
-            out = {}
-            from datetime import datetime
-            created_at = pull_request_data['created_at']
-            closed_at = pull_request_data['closed_at']
-            closed_at_datetime = datetime.strptime(closed_at, "%Y-%m-%dT%H:%M:%SZ")
-            created_at_datetime = datetime.strptime(created_at, "%Y-%m-%dT%H:%M:%SZ")
-            difference = closed_at_datetime - created_at_datetime
-            out['hours'] = difference.total_seconds() / 3600
-            out['commits'] = pull_request_data['commits']
-            out['comments'] = pull_request_data['comments']
-            out['review_comments'] = pull_request_data['review_comments']
-            out['changed_files'] = pull_request_data['changed_files']
-            out['additions'] = pull_request_data['additions']
-            out['deletions'] = pull_request_data['deletions']
-        except Exception as e:
-            get_logger().exception(f"Failed to calculate PR statistics, error: {e}")
-            return {}
-        return out
+        return {}

pr_agent/servers/github_action_runner.py

@@ -46,19 +46,22 @@ async def run_action():
     if not GITHUB_EVENT_PATH:
         print("GITHUB_EVENT_PATH not set")
         return
-    if not OPENAI_KEY:
-        print("OPENAI_KEY not set")
-        return
     if not GITHUB_TOKEN:
         print("GITHUB_TOKEN not set")
         return
 
     # Set the environment variables in the settings
-    get_settings().set("OPENAI.KEY", OPENAI_KEY)
+    if OPENAI_KEY:
+        get_settings().set("OPENAI.KEY", OPENAI_KEY)
+    else:
+        # Might not be set if the user is using models not from OpenAI
+        print("OPENAI_KEY not set")
     if OPENAI_ORG:
         get_settings().set("OPENAI.ORG", OPENAI_ORG)
     get_settings().set("GITHUB.USER_TOKEN", GITHUB_TOKEN)
     get_settings().set("GITHUB.DEPLOYMENT_TYPE", "user")
+    enable_output = get_setting_or_env("GITHUB_ACTION_CONFIG.ENABLE_OUTPUT", True)
+    get_settings().set("GITHUB_ACTION_CONFIG.ENABLE_OUTPUT", enable_output)
 
     # Load the event payload
     try:
@@ -101,6 +104,8 @@ async def run_action():
                     await PRReviewer(pr_url).run()
                 if auto_improve is None or is_true(auto_improve):
                     await PRCodeSuggestions(pr_url).run()
+        else:
+            get_logger().info(f"Skipping action: {action}")
 
     # Handle issue comment event
     elif GITHUB_EVENT_NAME == "issue_comment" or GITHUB_EVENT_NAME == "pull_request_review_comment":

pr_agent/servers/github_app.py

@@ -86,8 +86,13 @@ async def handle_comments_on_pr(body: Dict[str, Any],
         return {}
     comment_body = body.get("comment", {}).get("body")
     if comment_body and isinstance(comment_body, str) and not comment_body.lstrip().startswith("/"):
-        get_logger().info("Ignoring comment not starting with /")
-        return {}
+        if '/ask' in comment_body and comment_body.strip().startswith('> ![image]'):
+            comment_body_split = comment_body.split('/ask')
+            comment_body = '/ask' + comment_body_split[1] +' \n' +comment_body_split[0].strip().lstrip('>')
+            get_logger().info(f"Reformatting comment_body so command is at the beginning: {comment_body}")
+        else:
+            get_logger().info("Ignoring comment not starting with /")
+            return {}
     disable_eyes = False
     if "issue" in body and "pull_request" in body["issue"] and "url" in body["issue"]["pull_request"]:
         api_url = body["issue"]["pull_request"]["url"]
@@ -118,15 +123,9 @@ async def handle_new_pr_opened(body: Dict[str, Any],
                                event: str,
                                sender: str,
                                sender_id: str,
-                               sender_type: str,
                                action: str,
                                log_context: Dict[str, Any],
                                agent: PRAgent):
-    # logic to ignore PRs opened by bot
-    if get_settings().get("GITHUB_APP.IGNORE_BOT_PR", False) and sender_type == "Bot":
-        get_logger().info(f"Ignoring PR from '{sender=}' due to github_app.ignore_bot_pr setting")
-        return {}
-
     title = body.get("pull_request", {}).get("title", "")
 
     # logic to ignore PRs with specific titles (e.g. "[Auto] ...")
@@ -237,10 +236,11 @@ def get_log_context(body, event, action, build_number):
         sender_type = body.get("sender", {}).get("type")
         repo = body.get("repository", {}).get("full_name", "")
         git_org = body.get("organization", {}).get("login", "")
+        installation_id = body.get("installation", {}).get("id", "")
         app_name = get_settings().get("CONFIG.APP_NAME", "Unknown")
         log_context = {"action": action, "event": event, "sender": sender, "server_type": "github_app",
                        "request_id": uuid.uuid4().hex, "build_number": build_number, "app_name": app_name,
-                       "repo": repo, "git_org": git_org}
+                       "repo": repo, "git_org": git_org, "installation_id": installation_id}
     except Exception as e:
         get_logger().error("Failed to get log context", e)
         log_context = {}
@@ -261,6 +261,12 @@ async def handle_request(body: Dict[str, Any], event: str):
     agent = PRAgent()
     log_context, sender, sender_id, sender_type = get_log_context(body, event, action, build_number)
 
+    # logic to ignore PRs opened by bot
+    if get_settings().get("GITHUB_APP.IGNORE_BOT_PR", False) and sender_type == "Bot":
+        if 'pr-agent' not in sender:
+            get_logger().info(f"Ignoring PR from '{sender=}' because it is a bot")
+        return {}
+
     # handle comments on PRs
     if action == 'created':
         get_logger().debug(f'Request body', artifact=body, event=event)
@@ -268,7 +274,7 @@ async def handle_request(body: Dict[str, Any], event: str):
     # handle new PRs
     elif event == 'pull_request' and action != 'synchronize' and action != 'closed':
         get_logger().debug(f'Request body', artifact=body, event=event)
-        await handle_new_pr_opened(body, event, sender, sender_id, sender_type, action, log_context, agent)
+        await handle_new_pr_opened(body, event, sender, sender_id, action, log_context, agent)
     # handle pull_request event with synchronize action - "push trigger" for new commits
     elif event == 'pull_request' and action == 'synchronize':
         get_logger().debug(f'Request body', artifact=body, event=event)

pr_agent/servers/help.py

@@ -22,116 +22,22 @@ class HelpMessage:
     @staticmethod
     def get_review_usage_guide():
         output ="**Overview:**\n"
-        output +="The `review` tool scans the PR code changes, and generates a PR review. The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on any PR.\n"
+        output +=("The `review` tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be [added](https://pr-agent-docs.codium.ai/tools/review/#general-configurations) by configuring the tool.\n\n"
+                  "The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on any PR.\n")
         output +="""\
-When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L19) related to the review tool (`pr_reviewer` section), use the following template:
+- When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L23) related to the review tool (`pr_reviewer` section), use the following template:
 ```
 /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
 ```
-With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template:
+- With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template:
 ```
 [pr_reviewer]
 some_config1=...
 some_config2=...
 ```
     """
-        output +="\n\n<table>"
 
-        # extra instructions
-        output += "<tr><td><details> <summary><strong> Utilizing extra instructions</strong></summary><hr>\n\n"
-        output += '''\
-The `review` tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.
-
-Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.
-
-Examples for extra instructions:
-```
-[pr_reviewer] # /review #
-extra_instructions="""
-In the 'possible issues' section, emphasize the following:
-- Does the code logic cover relevant edge cases?
-- Is the code logic clear and easy to understand?
-- Is the code logic efficient?
-...
-"""
-```
-Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
-        '''
-        output += "\n\n</details></td></tr>\n\n"
-
-        # automation
-        output += "<tr><td><details> <summary><strong> How to enable\\disable automation</strong></summary><hr>\n\n"
-        output += """\
-- When you first install PR-Agent app, the [default mode](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) for the `review` tool is:
-```
-pr_commands = ["/review", ...]
-```
-meaning the `review` tool will run automatically on every PR, with the default configuration.
-Edit this field to enable/disable the tool, or to change the used configurations
-        """
-        output += "\n\n</details></td></tr>\n\n"
-
-#         # code feedback
-#         output += "<tr><td><details> <summary><strong> About the 'Code feedback' section</strong></summary><hr>\n\n"
-#         output+="""\
-# The `review` tool provides several type of feedbacks, one of them is code suggestions.
-# If you are interested **only** in the code suggestions, it is recommended to use the [`improve`](https://github.com/Codium-ai/pr-agent/blob/main/docs/IMPROVE.md) feature instead, since it dedicated only to code suggestions, and usually gives better results.
-# Use the `review` tool if you want to get a more comprehensive feedback, which includes code suggestions as well.
-# """
-#         output += "\n\n</details></td></tr>\n\n"
-
-        # auto-labels
-        output += "<tr><td><details> <summary><strong> Auto-labels</strong></summary><hr>\n\n"
-        output+="""\
-The `review` tool can auto-generate two specific types of labels for a PR:
-- a `possible security issue` label, that detects possible [security issues](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`enable_review_labels_security` flag)
-- a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag)
-"""
-        output += "\n\n</details></td></tr>\n\n"
-
-        # extra sub-tools
-        output += "<tr><td><details> <summary><strong> Extra sub-tools</strong></summary><hr>\n\n"
-        output += """\
-The `review` tool provides a collection of possible feedbacks about a PR.
-It is recommended to review the [possible options](https://pr-agent-docs.codium.ai/tools/review/#enabledisable-features), and choose the ones relevant for your use case.
-Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: 
-`require_score_review`, `require_soc2_ticket`, `require_can_be_split_review`, and more.
-"""
-        output += "\n\n</details></td></tr>\n\n"
-
-        output += "<tr><td><details> <summary><strong> Auto-approve PRs</strong></summary><hr>\n\n"
-        output += '''\
-By invoking:
-```
-/review auto_approve
-```
-The tool will automatically approve the PR, and add a comment with the approval.
-
-
-To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following:
-```
-[pr_reviewer]
-enable_auto_approval = true
-```
-(this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository)
-
-
-You can also enable auto-approval only if the PR meets certain requirements, such as that the `estimated_review_effort` is equal or below a certain threshold, by adjusting the flag:
-```
-[pr_reviewer]
-maximal_review_effort = 5
-```
-'''
-        output += "\n\n</details></td></tr>\n\n"
-
-        # general
-        output += "\n\n<tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> \n\n"
-        output += HelpMessage.get_general_bot_help_text()
-        output += "\n\n</details></td></tr>\n\n"
-
-        output += "</table>"
-
-        output += f"\n\nSee the [review usage](https://pr-agent-docs.codium.ai/tools/review/) page for a comprehensive guide on using this tool.\n\n"
+        output += f"\n\nSee the review [usage page](https://pr-agent-docs.codium.ai/tools/review/) for a comprehensive guide on using this tool.\n\n"
 
         return output
 
@@ -222,7 +128,7 @@ Be specific, clear, and concise in the instructions. With extra instructions, yo
 Examples for extra instructions:
 ```
 [pr_description] 
-extra_instructions="""
+extra_instructions="""\
 - The PR title should be in the format: '<PR type>: <title>'
 - The title should be short and concise (up to 10 words)
 - ...
@@ -254,16 +160,17 @@ It can be invoked manually by commenting on any PR:
 /ask "..."
 ```
 
-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.   
+You can ask questions about the entire PR, about specific code lines, or about an image related to the PR code changes.     
         """
-        output += "\n\n<table>"
-
-        # general
-        output += "\n\n<tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> \n\n"
-        output += HelpMessage.get_general_bot_help_text()
-        output += "\n\n</details></td></tr>\n\n"
-
-        output += "</table>"
+        # output += "\n\n<table>"
+        #
+        # # # general
+        # # output += "\n\n<tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> \n\n"
+        # # output += HelpMessage.get_general_bot_help_text()
+        # # output += "\n\n</details></td></tr>\n\n"
+        #
+        # output += "</table>"
 
         output += f"\n\nSee the [ask usage](https://pr-agent-docs.codium.ai/tools/ask/) page for a comprehensive guide on using this tool.\n\n"
 
@@ -276,13 +183,13 @@ Note that the tool does not have "memory" of previous questions, and answers eac
         output += "The `improve` tool scans the PR code changes, and automatically generates suggestions for improving the PR code. "
         output += "The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on a PR.\n"
         output += """\
-When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L69) related to the improve tool (`pr_code_suggestions` section), use the following template:
+- When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L78) related to the improve tool (`pr_code_suggestions` section), use the following template:
 
 ```
 /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
 ```
 
-With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template:
+- With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template:
 
 ```
 [pr_code_suggestions]
@@ -291,64 +198,7 @@ some_config2=...
 ```
     
 """
-        output += "\n\n<table>"
 
-        # automation
-        output += "<tr><td><details> <summary><strong> Enabling\\disabling automation </strong></summary><hr>\n\n"
-        output += """\
-When you first install the app, the [default mode](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) for the improve tool is:
-
-```
-pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]
-```
-
-meaning the `improve` tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.
-"""
-        output += "\n\n</details></td></tr>\n\n"
-
-        # extra instructions
-        output += "<tr><td><details> <summary><strong> Utilizing extra instructions</strong></summary><hr>\n\n"
-        output += '''\
-Extra instructions are very important for the `improve` tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.
-
-Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.
-
-Examples for extra instructions:
-
-```
-[pr_code_suggestions] # /improve #
-extra_instructions="""
-Emphasize the following aspects:
-- Does the code logic cover relevant edge cases?
-- Is the code logic clear and easy to understand?
-- Is the code logic efficient?
-...
-"""
-```
-
-Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
-    '''
-        output += "\n\n</details></td></tr>\n\n"
-
-        # suggestions quality
-        output += "\n\n<tr><td><details> <summary><strong> A note on code suggestions quality</strong></summary><hr> \n\n"
-        output += """\
-- While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
-- Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
-- Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the [custom suggestions :gem:](https://pr-agent-docs.codium.ai/tools/custom_suggestions/) tool
-- With large PRs, best quality will be obtained by using 'improve --extended' mode.
-
-
-"""
-        output += "\n\n</details></td></tr>\n\n"\
-
-        # general
-        output += "\n\n<tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> \n\n"
-        output += HelpMessage.get_general_bot_help_text()
-        output += "\n\n</details></td></tr>\n\n"
-
-        output += "</table>"
-
-        output += f"\n\nSee the [improve usage](https://pr-agent-docs.codium.ai/tools/improve/) page for a more comprehensive guide on using this tool.\n\n"
+        output += f"\n\nSee the improve [usage page](https://pr-agent-docs.codium.ai/tools/improve/) for a comprehensive guide on using this tool.\n\n"
 
         return output

pr_agent/settings/configuration.toml

@@ -1,7 +1,7 @@
 [config]
-model="gpt-4" # "gpt-4-0125-preview"
-model_turbo="gpt-4-0125-preview"
-fallback_models=["gpt-3.5-turbo-16k"]
+model="gpt-4-turbo-2024-04-09"
+model_turbo="gpt-4-turbo-2024-04-09"
+fallback_models=["gpt-4-0125-preview"]
 git_provider="github"
 publish_output=true
 publish_output_progress=true
@@ -36,7 +36,7 @@ ask_and_reflect=false
 #automatic_review=true
 persistent_comment=true
 extra_instructions = ""
-final_update_message = true
+disable_final_update_message = false
 # review labels
 enable_review_labels_security=true
 enable_review_labels_effort=true
@@ -51,16 +51,18 @@ maximal_review_effort=5
 
 
 [pr_description] # /describe #
-publish_labels=true
-publish_description_as_comment=false
+disable_publish_labels=false
 add_original_user_description=true
-keep_original_user_title=true
+generate_ai_title=false
 use_bullet_points=true
 extra_instructions = ""
 enable_pr_type=true
-final_update_message = true
+disable_final_update_message = false
 enable_help_text=false
 enable_help_comment=true
+# describe as comment
+publish_description_as_comment=false
+publish_description_as_comment_persistent=true
 ## changes walkthrough section
 enable_semantic_files_types=true
 collapsible_file_list='adaptive' # true, false, 'adaptive'
@@ -110,6 +112,11 @@ file = ""              # in case there are several components with the same name
 class_name = ""        # in case there are several methods with the same name in the same file, you can specify the relevant class name
 enable_help_text=true
 
+[pr_improve_component] # /improve_component #
+num_code_suggestions=4
+extra_instructions = ""
+file = ""              # in case there are several components with the same name, you can specify the relevant file
+class_name = ""
 
 [checks] # /checks (pro feature) #
 enable_auto_checks_feedback=true
@@ -133,6 +140,7 @@ try_fix_invalid_inline_comments = true
 # auto_review = true    # set as env var in .github/workflows/pr-agent.yaml
 # auto_describe = true  # set as env var in .github/workflows/pr-agent.yaml
 # auto_improve = true   # set as env var in .github/workflows/pr-agent.yaml
+# enable_output = true   # set as env var in .github/workflows/pr-agent.yaml
 
 [github_app]
 # these toggles allows running the github app from custom deployments
@@ -156,7 +164,7 @@ push_commands = [
     "/review --pr_reviewer.num_code_suggestions=0",
 ]
 ignore_pr_title = []
-ignore_bot_pr = false
+ignore_bot_pr = true
 
 [gitlab]
 url = "https://gitlab.com" # URL to the gitlab service

pr_agent/tools/pr_code_suggestions.py

@@ -76,7 +76,7 @@ class PRCodeSuggestions:
             relevant_configs = {'pr_code_suggestions': dict(get_settings().pr_code_suggestions),
                                 'config': dict(get_settings().config)}
             get_logger().debug("Relevant configs", artifacts=relevant_configs)
-            if get_settings().config.publish_output:
+            if get_settings().config.publish_output and get_settings().config.publish_output_progress:
                 if self.git_provider.is_supported("gfm_markdown"):
                     self.progress_response = self.git_provider.publish_comment(self.progress)
                 else:
@@ -196,24 +196,31 @@ class PRCodeSuggestions:
         suggestion_list = []
         one_sentence_summary_list = []
         for i, suggestion in enumerate(data['code_suggestions']):
-            if get_settings().pr_code_suggestions.summarize:
-                if not suggestion or 'one_sentence_summary' not in suggestion or 'label' not in suggestion or 'relevant_file' not in suggestion:
-                    get_logger().debug(f"Skipping suggestion {i + 1}, because it is invalid: {suggestion}")
-                    continue
-
-                if suggestion['one_sentence_summary'] in one_sentence_summary_list:
-                    get_logger().debug(f"Skipping suggestion {i + 1}, because it is a duplicate: {suggestion}")
-                    continue
-
-            if ('existing_code' in suggestion) and ('improved_code' in suggestion) and (
-                    suggestion['existing_code'] != suggestion['improved_code']):
-                suggestion = self._truncate_if_needed(suggestion)
+            try:
                 if get_settings().pr_code_suggestions.summarize:
-                    one_sentence_summary_list.append(suggestion['one_sentence_summary'])
-                suggestion_list.append(suggestion)
-            else:
-                get_logger().debug(
-                    f"Skipping suggestion {i + 1}, because existing code is equal to improved code {suggestion['existing_code']}")
+                    if not suggestion or 'one_sentence_summary' not in suggestion or 'label' not in suggestion or 'relevant_file' not in suggestion:
+                        get_logger().debug(f"Skipping suggestion {i + 1}, because it is invalid: {suggestion}")
+                        continue
+
+                    if suggestion['one_sentence_summary'] in one_sentence_summary_list:
+                        get_logger().debug(f"Skipping suggestion {i + 1}, because it is a duplicate: {suggestion}")
+                        continue
+
+                if 'const' in suggestion['suggestion_content'] and 'instead' in suggestion['suggestion_content'] and 'let' in suggestion['suggestion_content']:
+                    get_logger().debug(f"Skipping suggestion {i + 1}, because it uses 'const instead let': {suggestion}")
+                    continue
+
+                if ('existing_code' in suggestion) and ('improved_code' in suggestion) and (
+                        suggestion['existing_code'] != suggestion['improved_code']):
+                    suggestion = self._truncate_if_needed(suggestion)
+                    if get_settings().pr_code_suggestions.summarize:
+                        one_sentence_summary_list.append(suggestion['one_sentence_summary'])
+                    suggestion_list.append(suggestion)
+                else:
+                    get_logger().debug(
+                        f"Skipping suggestion {i + 1}, because existing code is equal to improved code {suggestion['existing_code']}")
+            except Exception as e:
+                get_logger().error(f"Error processing suggestion {i + 1}: {suggestion}, error: {e}")
         data['code_suggestions'] = suggestion_list
 
         return data

pr_agent/tools/pr_description.py

@@ -95,7 +95,10 @@ class PRDescription:
                 self.file_label_dict = self._prepare_file_labels()
 
             pr_labels, pr_file_changes = [], []
-            if get_settings().pr_description.publish_labels:
+            # backward compatibility support
+            publish_label = get_settings().pr_reviewer.get("publish_labels", True) \
+                            and not get_settings().pr_description.disable_publish_labels
+            if publish_label:
                 pr_labels = self._prepare_labels()
 
             if get_settings().pr_description.use_description_markers:
@@ -118,7 +121,7 @@ class PRDescription:
 
             if get_settings().config.publish_output:
                 # publish labels
-                if get_settings().pr_description.publish_labels and self.git_provider.is_supported("get_labels"):
+                if publish_label and self.git_provider.is_supported("get_labels"):
                     original_labels = self.git_provider.get_pr_labels(update=True)
                     get_logger().debug(f"original labels", artifact=original_labels)
                     user_labels = get_user_labels(original_labels)
@@ -132,12 +135,21 @@ class PRDescription:
                 # publish description
                 if get_settings().pr_description.publish_description_as_comment:
                     full_markdown_description = f"## Title\n\n{pr_title}\n\n___\n{pr_body}"
-                    self.git_provider.publish_comment(full_markdown_description)
+                    if get_settings().pr_description.publish_description_as_comment_persistent:
+                        self.git_provider.publish_persistent_comment(full_markdown_description,
+                                                                     initial_header="## Title",
+                                                                     update_header=True,
+                                                                     name="describe",
+                                                                     final_update_message=False, )
+                    else:
+                        self.git_provider.publish_comment(full_markdown_description)
                 else:
                     self.git_provider.publish_description(pr_title, pr_body)
 
-                    # publish final update message
-                    if (get_settings().pr_description.final_update_message):
+                    # publish final update message - with backward compatibility support
+                    publish_update_message = get_settings().pr_reviewer.get("final_update_message", True)\
+                                             and not get_settings().pr_description.disable_final_update_message
+                    if (publish_update_message):
                         latest_commit_url = self.git_provider.get_latest_commit_url()
                         if latest_commit_url:
                             pr_url = self.git_provider.get_pr_url()
@@ -294,7 +306,10 @@ class PRDescription:
 
         # Remove the 'PR Title' key from the dictionary
         ai_title = self.data.pop('title', self.vars["title"])
-        if get_settings().pr_description.keep_original_user_title:
+        # get config - with backward compatibility
+        keep_user_title = get_settings().pr_reviewer.get("keep_original_user_title", True) \
+                          and not get_settings().pr_description.generate_ai_title
+        if keep_user_title:
             # Assign the original PR title to the 'title' variable
             title = self.vars["title"]
         else:

pr_agent/tools/pr_help_message.py

@@ -27,12 +27,13 @@ class PRHelpMessage:
             tool_names.append(f"[DESCRIBE]({base_path}/describe/)")
             tool_names.append(f"[REVIEW]({base_path}/review/)")
             tool_names.append(f"[IMPROVE]({base_path}/improve/)")
-            tool_names.append(f"[ANALYZE]({base_path}/analyze/) 💎")
             tool_names.append(f"[UPDATE CHANGELOG]({base_path}/update_changelog/)")
-            tool_names.append(f"[ADD DOCUMENTATION]({base_path}/documentation/) 💎")
-            tool_names.append(f"[ASK]({base_path}/ask/)")
-            tool_names.append(f"[GENERATE CUSTOM LABELS]({base_path}/custom_labels/)")
+            tool_names.append(f"[ADD DOCS]({base_path}/documentation/) 💎")
             tool_names.append(f"[TEST]({base_path}/test/) 💎")
+            tool_names.append(f"[IMPROVE COMPONENT]({base_path}/improve_component/) 💎")
+            tool_names.append(f"[ANALYZE]({base_path}/analyze/) 💎")
+            tool_names.append(f"[ASK]({base_path}/ask/)")
+            tool_names.append(f"[GENERATE CUSTOM LABELS]({base_path}/custom_labels/) 💎")
             tool_names.append(f"[CI FEEDBACK]({base_path}/ci_feedback/) 💎")
             tool_names.append(f"[CUSTOM SUGGESTIONS]({base_path}/custom_suggestions/) 💎")
             tool_names.append(f"[SIMILAR ISSUE]({base_path}/similar_issues/)")
@@ -40,27 +41,29 @@ class PRHelpMessage:
             descriptions = []
             descriptions.append("Generates PR description - title, type, summary, code walkthrough and labels")
             descriptions.append("Adjustable feedback about the PR, possible issues, security concerns, review effort and more")
-            descriptions.append("Code suggestions for improving the PR.")
-            descriptions.append("Identifies code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component.")
-            descriptions.append("Automatically updates the changelog.")
-            descriptions.append("Generates documentation to methods/functions/classes that changed in the PR.")
-            descriptions.append("Answering free-text questions about the PR.")
+            descriptions.append("Code suggestions for improving the PR")
+            descriptions.append("Automatically updates the changelog")
+            descriptions.append("Generates documentation to methods/functions/classes that changed in the PR")
+            descriptions.append("Generates unit tests for a specific component, based on the PR code change")
+            descriptions.append("Code suggestions for a specific component that changed in the PR")
+            descriptions.append("Identifies code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component")
+            descriptions.append("Answering free-text questions about the PR")
             descriptions.append("Generates custom labels for the PR, based on specific guidelines defined by the user")
-            descriptions.append("Generates unit tests for a specific component, based on the PR code change.")
-            descriptions.append("Generates feedback and analysis for a failed CI job.")
-            descriptions.append("Generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.")
-            descriptions.append("Automatically retrieves and presents similar issues.")
+            descriptions.append("Generates feedback and analysis for a failed CI job")
+            descriptions.append("Generates custom suggestions for improving the PR code, based only on specific guidelines defined by the user")
+            descriptions.append("Automatically retrieves and presents similar issues")
 
             commands  =[]
             commands.append("`/describe`")
             commands.append("`/review`")
             commands.append("`/improve`")
-            commands.append("`/analyze`")
             commands.append("`/update_changelog`")
             commands.append("`/add_docs`")
+            commands.append("`/test`")
+            commands.append("`/improve_component`")
+            commands.append("`/analyze`")
             commands.append("`/ask`")
             commands.append("`/generate_labels`")
-            commands.append("`/test`")
             commands.append("`/checks`")
             commands.append("`/custom_suggestions`")
             commands.append("`/similar_issue`")
@@ -69,9 +72,13 @@ class PRHelpMessage:
             checkbox_list.append(" - [ ] Run <!-- /describe -->")
             checkbox_list.append(" - [ ] Run <!-- /review -->")
             checkbox_list.append(" - [ ] Run <!-- /improve -->")
-            checkbox_list.append(" - [ ] Run <!-- /analyze -->")
             checkbox_list.append(" - [ ] Run <!-- /update_changelog -->")
             checkbox_list.append(" - [ ] Run <!-- /add_docs -->")
+            checkbox_list.append(" - [ ] Run <!-- /test -->")
+            checkbox_list.append(" - [ ] Run <!-- /improve_component -->")
+            checkbox_list.append(" - [ ] Run <!-- /analyze -->")
+            checkbox_list.append("[*]")
+            checkbox_list.append("[*]")
             checkbox_list.append("[*]")
             checkbox_list.append("[*]")
             checkbox_list.append("[*]")
@@ -80,16 +87,16 @@ class PRHelpMessage:
             checkbox_list.append("[*]")
 
             if isinstance(self.git_provider, GithubProvider):
-                pr_comment += f"<table><tr align='center'><th align='center'>Tool</th><th align='center'>Description</th><th align='center'>Invoke Interactively :gem:</th></tr>"
+                pr_comment += f"<table><tr align='left'><th align='left'>Tool</th><th align='left'>Description</th><th align='left'>Trigger Interactively :gem:</th></tr>"
                 for i in range(len(tool_names)):
-                    pr_comment += f"\n<tr><td align='center'>\n\n<strong>{tool_names[i]}</strong></td>\n<td>{descriptions[i]}</td>\n<td>\n\n{checkbox_list[i]}\n</td></tr>"
+                    pr_comment += f"\n<tr><td align='left'>\n\n<strong>{tool_names[i]}</strong></td>\n<td>{descriptions[i]}</td>\n<td>\n\n{checkbox_list[i]}\n</td></tr>"
                 pr_comment += "</table>\n\n"
                 pr_comment += f"""\n\n(1) Note that each tool be [triggered automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools-for-pr-actions) when a new PR is opened, or called manually by [commenting on a PR](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#online-usage)."""
                 pr_comment += f"""\n\n(2) Tools marked with [*] require additional parameters to be passed. For example, to invoke the `/ask` tool, you need to comment on a PR: `/ask "<question content>"`. See the relevant documentation for each tool for more details."""
             else:
-                pr_comment += f"<table><tr align='center'><th align='center'>Tool</th><th align='left'>Command</th><th align='left'>Description</th></tr>"
+                pr_comment += f"<table><tr align='left'><th align='left'>Tool</th><th align='left'>Command</th><th align='left'>Description</th></tr>"
                 for i in range(len(tool_names)):
-                    pr_comment += f"\n<tr><td align='center'>\n\n<strong>{tool_names[i]}</strong></td><td>{commands[i]}</td><td>{descriptions[i]}</td></tr>"
+                    pr_comment += f"\n<tr><td align='left'>\n\n<strong>{tool_names[i]}</strong></td><td>{commands[i]}</td><td>{descriptions[i]}</td></tr>"
                 pr_comment += "</table>\n\n"
                 pr_comment += f"""\n\nNote that each tool be [invoked automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/) when a new PR is opened, or called manually by [commenting on a PR](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#online-usage)."""
             if get_settings().config.publish_output:

pr_agent/tools/pr_questions.py

@@ -56,6 +56,12 @@ class PRQuestions:
         get_logger().debug("Relevant configs", artifacts=relevant_configs)
         if get_settings().config.publish_output:
             self.git_provider.publish_comment("Preparing answer...", is_temporary=True)
+
+        # identify image
+        img_path = self.idenfity_image_in_comment()
+        if img_path:
+            get_logger().debug(f"Image path identified", artifact=img_path)
+
         await retry_with_fallback_models(self._prepare_prediction)
 
         pr_comment = self._prepare_pr_answer()
@@ -71,6 +77,19 @@ class PRQuestions:
             self.git_provider.remove_initial_comment()
         return ""
 
+    def idenfity_image_in_comment(self):
+        img_path = ''
+        if '![image]' in self.question_str:
+            # assuming structure:
+            # /ask question ...  > ![image](img_path)
+            img_path = self.question_str.split('![image]')[1].strip().strip('()')
+            self.vars['img_path'] = img_path
+        elif 'https://' in self.question_str and ('.png' in self.question_str or 'jpg' in self.question_str): # direct image link
+            # include https:// in the image path
+            img_path = 'https://' + self.question_str.split('https://')[1]
+            self.vars['img_path'] = img_path
+        return img_path
+
     async def _prepare_prediction(self, model: str):
         self.patches_diff = get_pr_diff(self.git_provider, self.token_handler, model)
         if self.patches_diff:
@@ -86,8 +105,14 @@ class PRQuestions:
         environment = Environment(undefined=StrictUndefined)
         system_prompt = environment.from_string(get_settings().pr_questions_prompt.system).render(variables)
         user_prompt = environment.from_string(get_settings().pr_questions_prompt.user).render(variables)
-        response, finish_reason = await self.ai_handler.chat_completion(model=model, temperature=0.2,
-                                                                        system=system_prompt, user=user_prompt)
+        if 'img_path' in variables:
+            img_path = self.vars['img_path']
+            response, finish_reason = await self.ai_handler.chat_completion(model=model, temperature=0.2,
+                                                                            system=system_prompt, user=user_prompt,
+                                                                            img_path=img_path)
+        else:
+            response, finish_reason = await self.ai_handler.chat_completion(model=model, temperature=0.2,
+                                                                            system=system_prompt, user=user_prompt)
         return response
 
     def _prepare_pr_answer(self) -> str:

pr_agent/tools/pr_reviewer.py

@@ -8,7 +8,7 @@ from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
 from pr_agent.algo.ai_handlers.litellm_ai_handler import LiteLLMAIHandler
 from pr_agent.algo.pr_processing import get_pr_diff, retry_with_fallback_models
 from pr_agent.algo.token_handler import TokenHandler
-from pr_agent.algo.utils import convert_to_markdown, load_yaml, ModelType
+from pr_agent.algo.utils import convert_to_markdown, github_action_output, load_yaml, ModelType
 from pr_agent.config_loader import get_settings
 from pr_agent.git_providers import get_git_provider
 from pr_agent.git_providers.git_provider import IncrementalPR, get_main_pr_language
@@ -135,7 +135,9 @@ class PRReviewer:
             if get_settings().config.publish_output:
                 # publish the review
                 if get_settings().pr_reviewer.persistent_comment and not self.incremental.is_incremental:
-                    final_update_message = get_settings().pr_reviewer.final_update_message
+                    # get config with backward compatibility
+                    final_update_message = get_settings().pr_reviewer.get("final_update_message", True)\
+                                           and not get_settings().pr_reviewer.disable_final_update_message
                     self.git_provider.publish_persistent_comment(pr_review,
                                                                  initial_header="## PR Review",
                                                                  update_header=True,
@@ -192,6 +194,7 @@ class PRReviewer:
         data = load_yaml(self.prediction.strip(),
                          keys_fix_yaml=["estimated_effort_to_review_[1-5]:", "security_concerns:", "possible_issues:",
                                         "relevant_file:", "relevant_line:", "suggestion:"])
+        github_action_output(data, 'review')
 
         if 'code_feedback' in data:
             code_feedback = data['code_feedback']
@@ -357,6 +360,9 @@ class PRReviewer:
         return True
 
     def set_review_labels(self, data):
+        if not get_settings().config.publish_output:
+            return
+
         if (get_settings().pr_reviewer.enable_review_labels_security or
                 get_settings().pr_reviewer.enable_review_labels_effort):
             try:

tests/unittest/test_clip_tokens.py

@@ -15,5 +15,5 @@ class TestClipTokens:
 
         max_tokens = 10
         result = clip_tokens(text, max_tokens)
-        expected_results = 'line1\nline2\nline3\nli...(truncated)'
+        expected_results = 'line1\nline2\nline3\nli\n...(truncated)'
         assert result == expected_results

tests/unittest/test_github_action_output.py

@@ -0,0 +1,50 @@
+import os
+import json
+from pr_agent.algo.utils import get_settings, github_action_output
+
+class TestGitHubOutput:
+    def test_github_action_output_enabled(self, monkeypatch, tmp_path):
+        get_settings().set('GITHUB_ACTION_CONFIG.ENABLE_OUTPUT', True)
+        monkeypatch.setenv('GITHUB_OUTPUT', str(tmp_path / 'output'))
+        output_data = {'key1': {'value1': 1, 'value2': 2}}
+        key_name = 'key1'
+        
+        github_action_output(output_data, key_name)
+        
+        with open(str(tmp_path / 'output'), 'r') as f:
+            env_value = f.read()
+        
+        actual_key = env_value.split('=')[0]
+        actual_data = json.loads(env_value.split('=')[1])
+        
+        assert actual_key == key_name
+        assert actual_data == output_data[key_name]
+    
+    def test_github_action_output_disabled(self, monkeypatch, tmp_path):
+        get_settings().set('GITHUB_ACTION_CONFIG.ENABLE_OUTPUT', False)
+        monkeypatch.setenv('GITHUB_OUTPUT', str(tmp_path / 'output'))
+        output_data = {'key1': {'value1': 1, 'value2': 2}}
+        key_name = 'key1'
+        
+        github_action_output(output_data, key_name)
+        
+        assert not os.path.exists(str(tmp_path / 'output'))
+
+    def test_github_action_output_notset(self, monkeypatch, tmp_path):
+        # not set config
+        monkeypatch.setenv('GITHUB_OUTPUT', str(tmp_path / 'output'))
+        output_data = {'key1': {'value1': 1, 'value2': 2}}
+        key_name = 'key1'
+        
+        github_action_output(output_data, key_name)
+        
+        assert not os.path.exists(str(tmp_path / 'output'))
+    
+    def test_github_action_output_error_case(self, monkeypatch, tmp_path):
+        monkeypatch.setenv('GITHUB_OUTPUT', str(tmp_path / 'output'))
+        output_data = None # invalid data
+        key_name = 'key1'
+        
+        github_action_output(output_data, key_name)
+        
+        assert not os.path.exists(str(tmp_path / 'output'))