docs: simplify repo statistics metrics description

Tr/v029

.dockerignore

@@ -1,2 +1,6 @@
+.venv/
 venv/
-pr_agent/settings/.secrets.toml
+pr_agent/settings/.secrets.toml
+pics/
+pr_agent.egg-info/
+build/

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,38 @@
+name: "\U0001FAB2 Bug Report"
+description: Submit a bug report
+labels: ["bug"]
+body:
+
+  - type: dropdown
+    id: information-git-provider
+    attributes:
+      label: Git provider
+      description: 'The problem arises when using:'
+      options:
+        - "Github Cloud"
+        - "Github Enterprise"
+        - "Gitlab"
+        - "Bitbucket Cloud"
+        - "Bitbucket Server"
+        - "Azure"
+        - "Other"
+    validations:
+      required: true
+
+  - type: textarea
+    id: system-info
+    attributes:
+      label: System Info
+      description: Please share your system info with us.
+      placeholder: model used, deployment type (action/app/cli/...), etc...
+    validations:
+      required: true
+
+  - type: textarea
+    id: bug-details
+    attributes:
+      label: Bug details
+      description: Please describe the problem.
+      placeholder: Describe the problem
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,10 @@
+blank_issues_enabled: false
+version: 0.1
+contact_links:
+  - name: Discussions
+    url: https://github.com/qodo-ai/pr-agent/discussions
+    about: GitHub Discussions
+
+  - name: Discord community
+    url: https://discord.com/channels/1057273017547378788/1126104260430528613
+    about: Join our discord community

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,21 @@
+name: "\U0001F4A1 Feature request"
+description: Submit a proposal/request for a new PR-Agent feature
+labels: ["feature"]
+body:
+  - type: textarea
+    id: feature-request
+    validations:
+      required: true
+    attributes:
+      label: Feature request
+      description: |
+        Description of the feature proposal.
+
+  - type: textarea
+    id: motivation
+    validations:
+      required: true
+    attributes:
+      label: Motivation
+      description: |
+        Outline the motivation for the proposal.

.github/ISSUE_TEMPLATE/miscellaneous.yml

@@ -0,0 +1,36 @@
+name: "❔ General Issue"
+description: Submit a general issue
+labels: ["general"]
+body:
+
+  - type: dropdown
+    id: information-git-provider
+    attributes:
+      label: Git provider (optional)
+      description: 'Git Provider:'
+      options:
+        - "Github Cloud"
+        - "Github Enterprise"
+        - "Gitlab"
+        - "Bitbucket Cloud"
+        - "Bitbucket Server"
+        - "Azure"
+        - "Other"
+
+  - type: textarea
+    id: system-info
+    attributes:
+      label: System Info (optional)
+      description: Please share your system info with us.
+      placeholder: model used, deployment type (action/app/cli/...), etc...
+    validations:
+      required: false
+
+  - type: textarea
+    id: issues-details
+    attributes:
+      label: Issues details
+      description: Please share the issues details.
+      placeholder: Describe the issue
+    validations:
+      required: true

.github/workflows/build-and-test.yaml

@@ -0,0 +1,39 @@
+name: Build-and-test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - id: checkout
+        uses: actions/checkout@v4
+
+      - id: dockerx
+        name: Setup Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - id: build
+        name: Build dev docker
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./docker/Dockerfile
+          push: false
+          load: true
+          tags: codiumai/pr-agent:test
+          cache-from: type=gha,scope=dev
+          cache-to: type=gha,mode=max,scope=dev
+          target: test
+
+      - id: test
+        name: Test dev docker
+        run: |
+          docker run --rm codiumai/pr-agent:test pytest -v tests/unittest

.github/workflows/code_coverage.yaml

@@ -0,0 +1,53 @@
+name: Code-coverage
+
+on:
+  workflow_dispatch:
+  # push:
+  #   branches:
+  #     - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - id: checkout
+        uses: actions/checkout@v4
+
+      - id: dockerx
+        name: Setup Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - id: build
+        name: Build dev docker
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./docker/Dockerfile
+          push: false
+          load: true
+          tags: codiumai/pr-agent:test
+          cache-from: type=gha,scope=dev
+          cache-to: type=gha,mode=max,scope=dev
+          target: test
+
+      - id: code_cov
+        name: Test dev docker
+        run: |
+          docker run --name test_container codiumai/pr-agent:test  pytest  tests/unittest --cov=pr_agent --cov-report term --cov-report xml:coverage.xml
+          docker cp test_container:/app/coverage.xml coverage.xml
+          docker rm test_container
+
+      - name: Validate coverage report
+        run: |
+          if [ ! -f coverage.xml ]; then
+            echo "Coverage report not found"
+            exit 1
+          fi
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/docs-ci.yaml

@@ -0,0 +1,33 @@
+name: docs-ci
+on:
+  push:
+    branches:
+      - main
+      - add-docs-portal
+    paths:
+      - docs/**
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            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

.github/workflows/e2e_tests.yaml

@@ -0,0 +1,45 @@
+name: PR-Agent E2E tests
+
+on:
+  workflow_dispatch:
+#  schedule:
+#    - cron: '0 0 * * *' # This cron expression runs the workflow every night at midnight UTC
+
+jobs:
+  pr_agent_job:
+    runs-on: ubuntu-latest
+    name: PR-Agent E2E GitHub App Test
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - id: build
+        name: Build dev docker
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./docker/Dockerfile
+          push: false
+          load: true
+          tags: codiumai/pr-agent:test
+          cache-from: type=gha,scope=dev
+          cache-to: type=gha,mode=max,scope=dev
+          target: test
+
+      - id: test1
+        name: E2E test github app
+        run: |
+          docker run -e GITHUB.USER_TOKEN=${{ secrets.TOKEN_GITHUB }} --rm codiumai/pr-agent:test pytest -v tests/e2e_tests/test_github_app.py
+
+      - id: test2
+        name: E2E gitlab webhook
+        run: |
+          docker run -e gitlab.PERSONAL_ACCESS_TOKEN=${{ secrets.TOKEN_GITLAB }} --rm codiumai/pr-agent:test pytest -v tests/e2e_tests/test_gitlab_webhook.py
+
+      - id: test3
+        name: E2E bitbucket app
+        run: |
+          docker run -e BITBUCKET.USERNAME=${{ secrets.BITBUCKET_USERNAME }}  -e BITBUCKET.PASSWORD=${{ secrets.BITBUCKET_PASSWORD }} --rm codiumai/pr-agent:test pytest -v tests/e2e_tests/test_bitbucket_app.py

.github/workflows/pr-agent-review.yaml

@@ -0,0 +1,32 @@
+# This workflow enables developers to call PR-Agents `/[actions]` in PR's comments and upon PR creation.
+# Learn more at https://www.codium.ai/pr-agent/
+# This is v0.2 of this workflow file
+
+name: PR-Agent
+
+on:
+# pull_request:
+# issue_comment:
+  workflow_dispatch:
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  pr_agent_job:
+    runs-on: ubuntu-latest
+    name: Run pr agent on every pull request
+    steps:
+      - name: PR Agent action step
+        id: pragent
+        uses: Codium-ai/pr-agent@main
+        env:
+          OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
+          OPENAI_ORG: ${{ secrets.OPENAI_ORG }} # optional
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PINECONE.API_KEY: ${{ secrets.PINECONE_API_KEY }}
+          PINECONE.ENVIRONMENT: ${{ secrets.PINECONE_ENVIRONMENT }}
+          GITHUB_ACTION_CONFIG.AUTO_DESCRIBE: true
+          GITHUB_ACTION_CONFIG.AUTO_REVIEW: true
+          GITHUB_ACTION_CONFIG.AUTO_IMPROVE: true

.github/workflows/pre-commit.yml

@@ -0,0 +1,17 @@
+# disabled. We might run it manually if needed.
+name: pre-commit
+
+on:
+  workflow_dispatch:
+#  pull_request:
+#  push:
+#    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+      # SEE https://github.com/pre-commit/action
+      - uses: pre-commit/action@v3.0.1

.gitignore

@@ -1,4 +1,15 @@
 .idea/
+.lsp/
+.vscode/
+.env
+.venv/
 venv/
 pr_agent/settings/.secrets.toml
-__pycache__
+__pycache__
+dist/
+*.egg-info/
+build/
+.DS_Store
+docs/.cache/
+.qodo
+poetry.lock

.pr_agent.toml

@@ -0,0 +1,3 @@
+[pr_reviewer]
+enable_review_labels_effort = true
+enable_auto_approval = true

.pre-commit-config.yaml

@@ -0,0 +1,46 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+default_language_version:
+  python: python3
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  # - repo: https://github.com/rhysd/actionlint
+  #   rev: v1.7.3
+  #   hooks:
+  #     - id: actionlint
+  - repo: https://github.com/pycqa/isort
+    # rev must match what's in dev-requirements.txt
+    rev: 5.13.2
+    hooks:
+      - id: isort
+  # - repo: https://github.com/PyCQA/bandit
+  #   rev: 1.7.10
+  #   hooks:
+  #     - id: bandit
+  #       args: [
+  #         "-c", "pyproject.toml",
+  #       ]
+  # - repo: https://github.com/astral-sh/ruff-pre-commit
+  #   rev: v0.7.1
+  #   hooks:
+  #     - id: ruff
+  #       args:
+  #         - --fix
+  #     - id: ruff-format
+  # -   repo: https://github.com/PyCQA/autoflake
+  #     rev: v2.3.1
+  #     hooks:
+  #     -   id: autoflake
+  #         args:
+  #           - --in-place
+  #           - --remove-all-unused-imports
+  #           - --remove-unused-variables

CHANGELOG.md

@@ -0,0 +1,50 @@
+## 2023-08-03
+
+### Optimized
+
+- Optimized PR diff processing by introducing caching for diff files, reducing the number of API calls.
+- Refactored `load_large_diff` function to generate a patch only when necessary.
+- Fixed a bug in the GitLab provider where the new file was not retrieved correctly.
+
+## 2023-08-02
+
+### Enhanced
+
+- Updated several tools in the `pr_agent` package to use commit messages in their functionality.
+- Commit messages are now retrieved and stored in the `vars` dictionary for each tool.
+- Added a section to display the commit messages in the prompts of various tools.
+
+## 2023-08-01
+
+### Enhanced
+
+- Introduced the ability to retrieve commit messages from pull requests across different git providers.
+- Implemented commit messages retrieval for GitHub and GitLab providers.
+- Updated the PR description template to include a section for commit messages if they exist.
+- Added support for repository-specific configuration files (.pr_agent.yaml) for the PR Agent.
+- Implemented this feature for both GitHub and GitLab providers.
+- Added a new configuration option 'use_repo_settings_file' to enable or disable the use of a repo-specific settings file.
+
+## 2023-07-30
+
+### Enhanced
+
+- Added the ability to modify any configuration parameter from 'configuration.toml' on-the-fly.
+- Updated the command line interface and bot commands to accept configuration changes as arguments.
+- Improved the PR agent to handle additional arguments for each action.
+
+## 2023-07-28
+
+### Improved
+
+- Enhanced error handling and logging in the GitLab provider.
+- Improved handling of inline comments and code suggestions in GitLab.
+- Fixed a bug where an additional unneeded line was added to code suggestions in GitLab.
+
+## 2023-07-26
+
+### Added
+
+- New feature for updating the CHANGELOG.md based on the contents of a PR.
+- Added support for this feature for the Github provider.
+- New configuration settings and prompts for the changelog update feature.

CODE_OF_CONDUCT.md

@@ -0,0 +1,44 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of fostering an open
+and welcoming community, we pledge to respect all people who contribute through reporting
+issues, posting feature requests, updating documentation, submitting pull requests or
+patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for
+everyone, regardless of level of experience, gender, gender identity and expression,
+sexual orientation, disability, personal appearance, body size, race, ethnicity, age,
+religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic addresses,
+  without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments,
+commits, code, wiki edits, issues, and other contributions that are not aligned to this
+Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors
+that they deem inappropriate, threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to fairly and
+consistently applying these principles to every aspect of managing this project. Project
+maintainers who do not follow or enforce the Code of Conduct may be permanently removed
+from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces when an
+individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
+contacting a project maintainer at tal.r@qodo.ai . All complaints will
+be reviewed and investigated and will result in a response that is deemed necessary and
+appropriate to the circumstances. Maintainers are obligated to maintain confidentiality
+with regard to the reporter of an incident.
+
+This Code of Conduct is adapted from the
+[Contributor Covenant](https://contributor-covenant.org), version 1.3.0, available at
+[contributor-covenant.org/version/1/3/0/](https://contributor-covenant.org/version/1/3/0/)

CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# Contributing to PR-Agent
+
+Thank you for your interest in contributing to the PR-Agent project!
+
+## Getting Started
+
+1. Fork the repository and clone your fork
+2. Install Python 3.10 or higher
+3. Install dependencies (`requirements.txt` and `requirements-dev.txt`)
+4. Create a new branch for your contribution:
+   - For new features: `git checkout -b feature/your-feature-name`
+   - For bug fixes: `git checkout -b fix/issue-description`
+5. Make your changes
+6. Write or update tests as needed
+7. Run tests locally to ensure everything passes
+8. Commit your changes using conventional commit messages
+9. Push to your fork and submit a pull request
+
+## Development Guidelines
+
+- Keep pull requests focused on a single feature or fix
+- Follow the existing code style and formatting conventions
+- Add unit tests for any new functionality using pytest
+- Ensure test coverage for your changes
+- Update documentation as needed
+
+## Pull Request Process
+
+1. Ensure your PR includes a clear description of the changes
+2. Link any related issues
+3. Update the README.md if needed
+4. Wait for review from maintainers
+
+## Questions or Need Help?
+
+- Join our [Discord community](https://discord.com/channels/1057273017547378788/1126104260430528613) for questions and discussions
+- Check the [documentation](https://qodo-merge-docs.qodo.ai/) for detailed information
+- Report bugs or request features through [GitHub Issues](https://github.com/qodo-ai/pr-agent/issues)

Dockerfile.github_action

@@ -0,0 +1,14 @@
+FROM python:3.12.10-slim AS base
+
+RUN apt-get update && apt-get install --no-install-recommends -y git curl && apt-get clean && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+ADD pyproject.toml .
+ADD requirements.txt .
+RUN pip install --no-cache-dir . && rm pyproject.toml requirements.txt
+ENV PYTHONPATH=/app
+ADD docs docs
+ADD pr_agent pr_agent
+ADD github_action/entrypoint.sh /
+RUN chmod +x /entrypoint.sh
+ENTRYPOINT ["/entrypoint.sh"]

Dockerfile.github_action_dockerhub

@@ -0,0 +1 @@
+FROM codiumai/pr-agent:github_action

LICENSE

@@ -199,4 +199,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include pr_agent *.toml
+recursive-exclude pr_agent *.secrets.toml

README.md

@@ -1,306 +1,260 @@
 <div align="center">
 
-<img src="./pics/Icon-7.png" alt="pr-agent_icon" width="100"/>
+<div align="center">
 
-# pr-agent
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://www.qodo.ai/wp-content/uploads/2025/02/PR-Agent-Purple-2.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://www.qodo.ai/wp-content/uploads/2025/02/PR-Agent-Purple-2.png">
+  <img src="https://codium.ai/images/pr_agent/logo-light.png" alt="logo" width="330">
 
-[![GitHub license](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/Codium-ai/pr-agent/blob/main/LICENSE)
-[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label&color=purple)](https://discord.com/channels/1057273017547378788/1126104260430528613)
+</picture>
+<br/>
 
-CodiumAI `pr-agent` is an open-source tool is powered by GPT-4 aming to help developers review PRs faster and more efficiently. It automatically analyzes the PR, and provides feedback and suggestions, and can answer questions.
+[Installation Guide](https://qodo-merge-docs.qodo.ai/installation/) |
+[Usage Guide](https://qodo-merge-docs.qodo.ai/usage-guide/) |
+[Tools Guide](https://qodo-merge-docs.qodo.ai/tools/) |
+[Qodo Merge](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) 💎
 
+PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedback and suggestions
 </div>
 
-- [Quickstart](#Quickstart)
-- [Usage and Tools](#usage-and-tools)
-- [Configuration](#Configuration)
-- [Roadmap](#roadmap)
-- [Similar projects](#similar-projects)
+[![Static Badge](https://img.shields.io/badge/Chrome-Extension-violet)](https://chromewebstore.google.com/detail/qodo-merge-ai-powered-cod/ephlnjeghhogofkifjloamocljapahnl)
+[![Static Badge](https://img.shields.io/badge/Pro-App-blue)](https://github.com/apps/qodo-merge-pro/)
+[![Static Badge](https://img.shields.io/badge/OpenSource-App-red)](https://github.com/apps/qodo-merge-pro-for-open-source/)
+[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label&color=purple)](https://discord.com/invite/SgSxuQ65GF)
+<a href="https://github.com/Codium-ai/pr-agent/commits/main">
+<img alt="GitHub" src="https://img.shields.io/github/last-commit/Codium-ai/pr-agent/main?style=for-the-badge" height="20">
+</a>
+</div>
 
-## Live demo
+## Table of Contents
 
-Experience GPT-4 powered PR review on your public Github repository with our hosted pr-agent. To try it, mention @CodiumAI-Agent in a PR comment! The agent will generate the review in response ([see details in the Usage section](#usage-and-tools)).
+- [News and Updates](#news-and-updates)
+- [Overview](#overview)
+- [Example results](#example-results)
+- [Try it now](#try-it-now)
+- [Qodo Merge](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/)
+- [How it works](#how-it-works)
+- [Why use PR-Agent?](#why-use-pr-agent)
+- [Data privacy](#data-privacy)
+- [Contributing](#contributing)
+- [Links](#links)
 
-![Review generation process](./pics/pr-agent-review-process1.gif)
+## News and Updates
+
+## May 17, 2025
+
+- v0.29 was [released](https://github.com/qodo-ai/pr-agent/releases)
+- `Qodo Merge Pull Request Benchmark` was [released](https://qodo-merge-docs.qodo.ai/pr_benchmark/). This benchmark  evaluates and compares the performance of LLMs in analyzing pull request code.
+- `Recent Updates and Future Roadmap` page was added to the [Qodo Merge Docs](https://qodo-merge-docs.qodo.ai/recent_updates/)
+
+## Apr 30, 2025
+
+A new feature is now available in the `/improve` tool for Qodo Merge 💎 - Chat on code suggestions.
+
+<img width="512" alt="image" src="https://codium.ai/images/pr_agent/improve_chat_on_code_suggestions_ask.png" />
+
+Read more about it [here](https://qodo-merge-docs.qodo.ai/tools/improve/#chat-on-code-suggestions).
+
+## Apr 16, 2025
+
+New tool for Qodo Merge 💎 - `/scan_repo_discussions`.
+
+<img width="635" alt="image" src="https://codium.ai/images/pr_agent/scan_repo_discussions_2.png" />
+
+Read more about it [here](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/).
+
+## Overview
+
+<div style="text-align:left;">
+
+Supported commands per platform:
+
+|       |                                                                                                         | GitHub | GitLab | Bitbucket | Azure DevOps |
+| ----- |---------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|
+| TOOLS | [Review](https://qodo-merge-docs.qodo.ai/tools/review/)                                                 |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Describe](https://qodo-merge-docs.qodo.ai/tools/describe/)                                             |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Improve](https://qodo-merge-docs.qodo.ai/tools/improve/)                                               |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Ask](https://qodo-merge-docs.qodo.ai/tools/ask/)                                                       |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | ⮑ [Ask on code lines](https://qodo-merge-docs.qodo.ai/tools/ask/#ask-lines)                             |   ✅   |   ✅   |           |              |
+|       | [Update CHANGELOG](https://qodo-merge-docs.qodo.ai/tools/update_changelog/)                             |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Help Docs](https://qodo-merge-docs.qodo.ai/tools/help_docs/?h=auto#auto-approval)                      |   ✅   |   ✅   |    ✅     |              |
+|       | [Ticket Context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/) 💎            |   ✅   |   ✅   |    ✅     |              |
+|       | [Utilizing Best Practices](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) 💎            |   ✅   |   ✅   |    ✅     |              |
+|       | [PR Chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) 💎                        |   ✅   |        |           |              |
+|       | [Suggestion Tracking](https://qodo-merge-docs.qodo.ai/tools/improve/#suggestion-tracking) 💎            |   ✅   |   ✅   |           |              |
+|       | [CI Feedback](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/) 💎                                    |   ✅   |        |           |              |
+|       | [PR Documentation](https://qodo-merge-docs.qodo.ai/tools/documentation/) 💎                             |   ✅   |   ✅   |           |              |
+|       | [Custom Labels](https://qodo-merge-docs.qodo.ai/tools/custom_labels/) 💎                                |   ✅   |   ✅   |           |              |
+|       | [Analyze](https://qodo-merge-docs.qodo.ai/tools/analyze/) 💎                                            |   ✅   |   ✅   |           |              |
+|       | [Similar Code](https://qodo-merge-docs.qodo.ai/tools/similar_code/) 💎                                  |   ✅   |        |           |              |
+|       | [Custom Prompt](https://qodo-merge-docs.qodo.ai/tools/custom_prompt/) 💎                                |   ✅   |   ✅   |    ✅     |              |
+|       | [Test](https://qodo-merge-docs.qodo.ai/tools/test/) 💎                                                  |   ✅   |   ✅   |           |              |
+|       | [Implement](https://qodo-merge-docs.qodo.ai/tools/implement/) 💎                                        |   ✅   |   ✅   |    ✅     |              |
+|       | [Scan Repo Discussions](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/) 💎                |   ✅   |        |           |              |
+|       | [Repo Statistics](https://qodo-merge-docs.qodo.ai/tools/repo_statistics/) 💎                            |   ✅   |        |           |              |
+|       | [Auto-Approve](https://qodo-merge-docs.qodo.ai/tools/improve/?h=auto#auto-approval) 💎                  |   ✅   |   ✅   |    ✅     |              |
+|       |                                                                                                         |        |        |           |              |
+| USAGE | [CLI](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#local-repo-cli)                |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [App / webhook](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#github-app)          |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Tagging bot](https://github.com/Codium-ai/pr-agent#try-it-now)                                         |   ✅   |        |           |              |
+|       | [Actions](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action)                  |   ✅   |   ✅   |    ✅     |      ✅      |
+|       |                                                                                                         |        |        |           |              |
+| CORE  | [PR compression](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/)                  |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | Adaptive and token-aware file patch fitting                                                             |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Multiple models support](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/)                |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/)                   |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/)                      |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Self reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/)                      |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/) 💎         |   ✅   |   ✅   |           |              |
+|       | [Global and wiki configurations](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) 💎 |   ✅   |   ✅   |    ✅     |              |
+|       | [PR interactive actions](https://www.qodo.ai/images/pr_agent/pr-actions.mp4) 💎                         |   ✅   |   ✅   |           |              |
+|       | [Impact Evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) 💎               |   ✅   |   ✅   |           |              |
+|       | [Code Validation 💎](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/)                   |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Auto Best Practices 💎](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/)           |   ✅   |      |         |            |
+- 💎 means this feature is available only in [Qodo Merge](https://www.qodo.ai/pricing/)
+
+[//]: # (- Support for additional git providers is described in [here]&#40;./docs/Full_environments.md&#41;)
+___
+
+‣ **Auto Description ([`/describe`](https://qodo-merge-docs.qodo.ai/tools/describe/))**: Automatically generating PR description - title, type, summary, code walkthrough and labels.
+\
+‣ **Auto Review ([`/review`](https://qodo-merge-docs.qodo.ai/tools/review/))**: Adjustable feedback about the PR, possible issues, security concerns, review effort and more.
+\
+‣ **Code Suggestions ([`/improve`](https://qodo-merge-docs.qodo.ai/tools/improve/))**: Code suggestions for improving the PR.
+\
+‣ **Question Answering ([`/ask ...`](https://qodo-merge-docs.qodo.ai/tools/ask/))**: Answering free-text questions about the PR.
+\
+‣ **Update Changelog ([`/update_changelog`](https://qodo-merge-docs.qodo.ai/tools/update_changelog/))**: Automatically updating the CHANGELOG.md file with the PR changes.
+\
+‣ **Help Docs ([`/help_docs`](https://qodo-merge-docs.qodo.ai/tools/help_docs/))**: Answers a question on any repository by utilizing given documentation.
+\
+‣ **Add Documentation 💎  ([`/add_docs`](https://qodo-merge-docs.qodo.ai/tools/documentation/))**: Generates documentation to methods/functions/classes that changed in the PR.
+\
+‣ **Generate Custom Labels 💎 ([`/generate_labels`](https://qodo-merge-docs.qodo.ai/tools/custom_labels/))**: Generates custom labels for the PR, based on specific guidelines defined by the user.
+\
+‣ **Analyze 💎 ([`/analyze`](https://qodo-merge-docs.qodo.ai/tools/analyze/))**: Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component.
+\
+‣ **Test 💎 ([`/test`](https://qodo-merge-docs.qodo.ai/tools/test/))**: Generate tests for a selected component, based on the PR code changes.
+\
+‣ **Custom Prompt 💎 ([`/custom_prompt`](https://qodo-merge-docs.qodo.ai/tools/custom_prompt/))**: Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.
+\
+‣ **Generate Tests 💎 ([`/test component_name`](https://qodo-merge-docs.qodo.ai/tools/test/))**: Generates unit tests for a selected component, based on the PR code changes.
+\
+‣ **CI Feedback 💎 ([`/checks ci_job`](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/))**: Automatically generates feedback and analysis for a failed CI job.
+\
+‣ **Similar Code 💎 ([`/find_similar_component`](https://qodo-merge-docs.qodo.ai/tools/similar_code/))**: Retrieves the most similar code components from inside the organization's codebase, or from open-source code.
+\
+‣ **Implement 💎 ([`/implement`](https://qodo-merge-docs.qodo.ai/tools/implement/))**: Generates implementation code from review suggestions.
+___
+
+## Example results
+
+</div>
+<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>
+<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>
+<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>
+
+<div align="left">
+
+</div>
+<hr>
+
+## Try it now
+
+Try the Claude Sonnet powered PR-Agent instantly on _your public GitHub repository_. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command.
+For example, add a comment to any pull request with the following text:
+
+```
+@CodiumAI-Agent /review
+```
+
+and the agent will respond with a review of your PR.
+
+Note that this is a promotional bot, suitable only for initial experimentation.
+It does not have 'edit' access to your repo, for example, so it cannot update the PR description or add labels (`@CodiumAI-Agent /describe` will publish PR description as a comment). In addition, the bot cannot be used on private repositories, as it does not have access to the files there.
 
 ---
 
-## Quickstart
+## Qodo Merge 💎
 
-To get started with pr-agent quickly, you first need to acquire two tokens:
+[Qodo Merge](https://www.qodo.ai/pricing/) is a hosted version of PR-Agent, provided by Qodo. It is available for a monthly fee, and provides the following benefits:
 
-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.
+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 Qodo Merge app to your GitHub/GitLab/BitBucket repo.
+2. **Improved privacy** - No data will be stored or used to train models. Qodo Merge will employ zero data retention, and will use an OpenAI account with zero data retention.
+3. **Improved support** - Qodo Merge 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, Qodo Merge will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results.
+See [here](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) for a list of features available in Qodo Merge.
 
-There are several ways to use pr-agent. Let's start with the simplest one:
+## How it works
 
----
+The following diagram illustrates PR-Agent tools and their flow:
 
-#### Method 1: Use Docker image (no installation required)
+![PR-Agent Tools](https://www.qodo.ai/images/pr_agent/diagram-v0.9.png)
 
-To request a review for a PR, or ask a question about a PR, you can run directly from the Docker image. Here's how:
+Check out the [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) page for more details on how we convert a code diff to a manageable LLM prompt
 
-1. To request a review for a PR, run the following command:
+## Why use PR-Agent?
 
-```
-docker run --rm -it -e OPENAI.KEY=<your key> -e GITHUB.USER_TOKEN=<your token> codiumai/pr-agent --pr_url <pr url>
-```
+A reasonable question that can be asked is: `"Why use PR-Agent? What makes it stand out from existing tools?"`
 
-2. To ask a question about a PR, run the following command:
+Here are some advantages of PR-Agent:
 
-```
-docker run --rm -it -e OPENAI.KEY=<your key> -e GITHUB.USER_TOKEN=<your token> codiumai/pr-agent --pr_url <pr url> --question "<your question>"
-```
+- We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single LLM call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably.
+- Our [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy)  is a core ability that enables to effectively tackle both short and long PRs.
+- Our JSON prompting strategy enables to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the [configuration](pr_agent/settings/configuration.toml) file. Adding additional categories is easy and accessible.
+- We support **multiple git providers** (GitHub, GitLab, BitBucket), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT, Claude, Deepseek, ...)
 
-Possible questions you can ask include:
+## Data privacy
 
-- What is the main theme of this PR?
-- Is the PR ready for merge?
-- What are the main changes in this PR?
-- Should this PR be split into smaller parts?
-- Can you compose a rhymed song about this PR.
+### Self-hosted PR-Agent
 
----
+- 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
 
-#### Method 2: Run from source
+### Qodo-hosted Qodo Merge 💎
 
-1. Clone this repository:
+- When using Qodo Merge 💎, hosted by Qodo, we will not store any of your data, nor will we use it for training. You will also benefit from an OpenAI account with zero data retention.
 
-```
-git clone https://github.com/Codium-ai/pr-agent.git
-```
+- For certain clients, Qodo-hosted Qodo Merge will use Qodo’s proprietary models — if this is the case, you will be notified.
 
-2. Install the requirements in your favorite virtual environment:
+- No passive collection of Code and Pull Requests’ data — Qodo Merge will be active only when you invoke it, and it will then extract and analyze only data relevant to the executed command and queried pull request.
 
-```
-pip install -r requirements.txt
-```
+### Qodo Merge Chrome extension
 
-3. Copy the secrets template file and fill in your OpenAI key and your GitHub user token:
+- The [Qodo Merge Chrome extension](https://chromewebstore.google.com/detail/qodo-merge-ai-powered-cod/ephlnjeghhogofkifjloamocljapahnl) serves solely to modify the visual appearance of a GitHub PR screen. It does not transmit any user's repo or pull request code. Code is only sent for processing when a user submits a GitHub comment that activates a PR-Agent tool, in accordance with the standard privacy policy of Qodo-Merge.
 
-```
-cp pr_agent/settings/.secrets_template.toml pr_agent/settings/.secrets
-# Edit .secrets file
-```
+## Contributing
 
-4. Run the appropriate Python scripts from the scripts folder:
+To contribute to the project, get started by reading our [Contributing Guide](https://github.com/qodo-ai/pr-agent/blob/b09eec265ef7d36c232063f76553efb6b53979ff/CONTRIBUTING.md).
 
-```
-python pr_agent/cli.py --pr_url <pr url>
-python pr_agent/cli.py --pr_url <pr url> --question "<your question>"
-```
+## Links
 
----
-
-#### Method 3: Method 3: Run as a polling server; request reviews by tagging your Github user on a PR
-
-Follow steps 1-3 of method 2.
-Run the following command to start the server:
-
-```
-python pr_agent/servers/github_polling.py
-```
-
----
-
-#### Method 4: Run as a Github App, allowing you to automate the review process on your private or public repositories.
-
-1. Create a GitHub App from the [Github Developer Portal](https://docs.github.com/en/developers/apps/creating-a-github-app).
-
-   - Set the following permissions:
-     - Pull requests: Read & write
-     - Issue comment: Read & write
-     - Metadata: Read-only
-   - Set the following events:
-     - Issue comment
-     - Pull request
-
-2. Generate a random secret for your app, and save it for later. For example, you can use:
-
-```
-WEBHOOK_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))")
-```
-
-3. Acquire the following pieces of information from your app's settings page:
-
-   - App private key (click "Generate a private key", and save the file)
-   - App ID
-
-4. Clone this repository:
-
-```
-git clone https://github.com/Codium-ai/pr-agent.git
-```
-
-5. Copy the secrets template file and fill in the following:
-   - Your OpenAI key.
-   - Set deployment_type to 'app'
-   - Copy your app's private key to the private_key field.
-   - Copy your app's ID to the app_id field.
-   - Copy your app's webhook secret to the webhook_secret field.
-
-```
-cp pr_agent/settings/.secrets_template.toml pr_agent/settings/.secrets
-# Edit .secrets file
-```
-
-6. Build a Docker image for the app and optionally push it to a Docker repository. We'll use Dockerhub as an example:
-
-```
-docker build . -t codiumai/pr-agent:github_app --target github_app -f docker/Dockerfile
-docker push codiumai/pr-agent:github_app  # Push to your Docker repository
-```
-
-7. Host the app using a server, serverless function, or container environment. Alternatively, for development and
-   debugging, you may use tools like smee.io to forward webhooks to your local machine.
-
-8. Go back to your app's settings, set the following:
-
-   - Webhook URL: The URL of your app's server, or the URL of the smee.io channel.
-   - Webhook secret: The secret you generated earlier.
-
-9. Install the app by navigating to the "Install App" tab, and selecting your desired repositories.
-
----
-
-## Usage and Tools
-
-CodiumAI pr-agent provides two types of interactions ("tools"): `"PR Reviewer"` and `"PR Q&A"`.
-
-- The "PR Reviewer" tool automatically analyzes PRs, and provides different types of feedbacks.
-- The "PR Q&A" tool answers free-text questions about the PR.
-
-### PR Reviewer
-
-Here is a quick overview of the different sub-tools of PR Reviewer:
-
-- PR Analysis
-  - Summarize main theme
-  - PR description and title
-  - PR type classification
-  - Is the PR covered by relevant tests
-  - Is the PR minimal and focused
-  - Are there security concerns
-- PR Feedback
-  - General PR suggestions
-  - Code suggestions
-
-This is how a typical output of the PR Reviewer looks like:
-
----
-
-#### PR Analysis
-
-- 🎯 **Main theme:** Adding language extension handler and token handler
-- 🔍 **Description and title:** Yes
-- 📌 **Type of PR:** Enhancement
-- 🧪 **Relevant tests added:** No
-- ✨ **Minimal and focused:** Yes, the PR is focused on adding two new handlers for language extension and token counting.
-- 🔒 **Security concerns:** No, the PR does not introduce possible security concerns or issues.
-
-#### PR Feedback
-
-- 💡 **General PR suggestions:** The PR is generally well-structured and the code is clean. However, it would be beneficial to add some tests to ensure the new handlers work as expected. Also, consider adding docstrings to the new functions and classes to improve code readability and maintainability.
-
-- 🤖 **Code suggestions:**
-
-  - **relevant file:** pr_agent/algo/language_handler.py
-
-    **suggestion content:** Consider using a set instead of a list for 'bad_extensions' as checking membership in a set is faster than in a list. [medium]
-
-  - **relevant file:** pr_agent/algo/language_handler.py
-
-    **suggestion content:** In the 'filter_bad_extensions' function, you are splitting the filename on '.' and taking the last element to get the extension. This might not work as expected if the filename contains multiple '.' characters. Consider using 'os.path.splitext' to get the file extension more reliably. [important]
-
----
-
-### PR Q&A
-
-This tool answers free-text questions about the PR. This is how a typical output of the PR Q&A looks like:
-
-**Question**: summarize for me the PR in 4 bullet points
-
-**Answer**:
-
-- The PR introduces a new feature to sort files by their main languages. It uses a mapping of programming languages to their file extensions to achieve this.
-- It also introduces a filter to exclude files with certain extensions, deemed as 'bad extensions', from the sorting process.
-- The PR modifies the `get_pr_diff` function in `pr_processing.py` to use the new sorting function. It also refactors the code to move the PR pruning logic into a separate function.
-- A new `TokenHandler` class is introduced in `token_handler.py` to handle token counting operations. This class is initialized with a PR, variables, system, and user, and provides methods to get system and user tokens and to count tokens in a patch.
-
----
-
-## Configuration
-
-The different tools and sub-tools used by CodiumAI pr-agent are easily configurable via the configuration file: `/settings/configuration.toml`.
-
-#### Enabling/disabling sub-tools:
-
-You can enable/disable the different PR Reviewer sub-sections with the following flags:
-
-```
-require_minimal_and_focused_review=true
-require_tests_review=true
-require_security_review=true
-```
-
-#### Code Suggestions configuration:
-
-There are also configuration options to control different aspects of the `code suggestions` feature.
-The number of suggestions provided can be controlled by adjusting the following parameter:
-
-```
-num_code_suggestions=4
-```
-
-You can also enable more verbose and informative mode of code suggestions:
-
-```
-extended_code_suggestions=false
-```
-
-This is a comparison of the regular and extended code suggestions modes:
-
-- **relevant file:** sql.py
-- **suggestion content:** Remove hardcoded sensitive information like username and password. Use environment variables or a secure method to store these values. [important]
-
-Example for extended suggestion:
-
-- **relevant file:** sql.py
-- **suggestion content:** Remove hardcoded sensitive information (username and password) [important]
-- **why:** Hardcoding sensitive information is a security risk. It's better to use environment variables or a secure way to store these values.
-- **code example:**
-  - **before code:**
-    ```
-    user = "root",
-    password = "Mysql@123",
-    ```
-  - **after code:**
-    ```
-    user = os.getenv('DB_USER'),
-    password = os.getenv('DB_PASSWORD'),
-    ```
-
----
-
-## Roadmap
-
-- [ ] Support open-source models, as a replacement for openai models. Note that a minimal requirement for each open-source model is to have 8k+ context, and good support for generating json as an output
-- [ ] Support other Git providers, such as Gitlab and Bitbucket.
-- [ ] Develop additional logics for handling large PRs, and compressing git patches
-- [ ] Dedicated tools and sub-tools for specific programming languages (Python, Javascript, Java, C++, etc)
-- [ ] Add additional context to the prompt. For example, repo (or relevant files) summarization, with tools such a [ctags](https://github.com/universal-ctags/ctags)
-- [ ] Adding more tools. Possible directions:
-  - [ ] Code Quality
-  - [ ] Coding Style
-  - [ ] Performance (are there any performance issues)
-  - [ ] Documentation (is the PR properly documented)
-  - [ ] Rank the PR importance
-  - [ ] ...
-
-## Similar Projects
-
-- [CodiumAI - Meaningful tests for busy devs](https://github.com/Codium-ai/codiumai-vscode-release)
-- [Aider - GPT powered coding in your terminal](https://github.com/paul-gauthier/aider)
-- [GPT-Engineer](https://github.com/AntonOsika/gpt-engineer)
-- [CodeReview BOT](https://github.com/anc95/ChatGPT-CodeReview)
-- [AI-Maintainer](https://github.com/merwanehamadi/AI-Maintainer)
+- Discord community: https://discord.gg/kG35uSHDBc
+- Qodo site: https://www.qodo.ai/
+- Blog: https://www.qodo.ai/blog/
+- Troubleshooting: https://www.qodo.ai/blog/technical-faq-and-troubleshooting/
+- Support: support@qodo.ai

RELEASE_NOTES.md

@@ -0,0 +1,118 @@
+## [Version 0.11] - 2023-12-07
+
+- codiumai/pr-agent:0.11
+- codiumai/pr-agent:0.11-github_app
+- codiumai/pr-agent:0.11-bitbucket-app
+- codiumai/pr-agent:0.11-gitlab_webhook
+- codiumai/pr-agent:0.11-github_polling
+- codiumai/pr-agent:0.11-github_action
+
+### Added::Algo
+
+- New section in `/describe` tool - [PR changes walkthrough](https://github.com/Codium-ai/pr-agent/pull/509)
+- Improving PR Agent [prompts](https://github.com/Codium-ai/pr-agent/pull/501)
+- Persistent tools (`/review`, `/describe`) now send an [update message](https://github.com/Codium-ai/pr-agent/pull/499) after finishing
+- Add Amazon Bedrock [support](https://github.com/Codium-ai/pr-agent/pull/483)
+
+### Fixed
+
+- Update [dependencies](https://github.com/Codium-ai/pr-agent/pull/503) in requirements.txt for Python 3.12
+
+## [Version 0.10] - 2023-11-15
+
+- codiumai/pr-agent:0.10
+- codiumai/pr-agent:0.10-github_app
+- codiumai/pr-agent:0.10-bitbucket-app
+- codiumai/pr-agent:0.10-gitlab_webhook
+- codiumai/pr-agent:0.10-github_polling
+- codiumai/pr-agent:0.10-github_action
+
+### Added::Algo
+
+- Review tool now works with [persistent comments](https://github.com/Codium-ai/pr-agent/pull/451) by default
+- Bitbucket now publishes review suggestions with [code links](https://github.com/Codium-ai/pr-agent/pull/428)
+- Enabling to limit [max number of tokens](https://github.com/Codium-ai/pr-agent/pull/437/files)
+- Support ['gpt-4-1106-preview'](https://github.com/Codium-ai/pr-agent/pull/437/files) model
+- Support for Google's [Vertex AI](https://github.com/Codium-ai/pr-agent/pull/436)
+- Implementing [thresholds](https://github.com/Codium-ai/pr-agent/pull/423) for incremental PR reviews
+- Decoupled custom labels from [PR type](https://github.com/Codium-ai/pr-agent/pull/431)
+
+### Fixed
+
+- Fixed bug in [parsing quotes](https://github.com/Codium-ai/pr-agent/pull/446) in CLI
+- Preserve [user-added labels](https://github.com/Codium-ai/pr-agent/pull/433) in pull requests
+- Bug fixes in GitLab and BitBucket
+
+## [Version 0.9] - 2023-10-29
+
+- codiumai/pr-agent:0.9
+- codiumai/pr-agent:0.9-github_app
+- codiumai/pr-agent:0.9-bitbucket-app
+- codiumai/pr-agent:0.9-gitlab_webhook
+- codiumai/pr-agent:0.9-github_polling
+- codiumai/pr-agent:0.9-github_action
+
+### Added::Algo
+
+- New tool - [generate_labels](https://github.com/Codium-ai/pr-agent/blob/main/docs/GENERATE_CUSTOM_LABELS.md)
+- New ability to use [customize labels](https://github.com/Codium-ai/pr-agent/blob/main/docs/GENERATE_CUSTOM_LABELS.md#how-to-enable-custom-labels) on the `review` and `describe` tools.
+- New tool - [add_docs](https://github.com/Codium-ai/pr-agent/blob/main/docs/ADD_DOCUMENTATION.md)
+- GitHub Action: Can now use a `.pr_agent.toml` file to control configuration parameters (see [Usage Guide](./Usage.md#working-with-github-action)).
+- GitHub App: Added ability to trigger tools on [push events](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools-for-new-code-pr-push)
+- Support custom domain URLs for Azure devops integration (see [link](https://github.com/Codium-ai/pr-agent/pull/381)).
+- PR Description default mode is now in [bullet points](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L35).
+
+### Added::Documentation
+
+Significant documentation updates (see [Installation Guide](https://github.com/Codium-ai/pr-agent/blob/main/INSTALL.md), [Usage Guide](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md), and [Tools Guide](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md))
+
+### Fixed
+
+- Fixed support for BitBucket pipeline (see [link](https://github.com/Codium-ai/pr-agent/pull/386))
+- Fixed a bug in `review -i` tool
+- Added blacklist for specific file extensions in `add_docs` tool (see [link](https://github.com/Codium-ai/pr-agent/pull/385/))
+
+## [Version 0.8] - 2023-09-27
+
+- codiumai/pr-agent:0.8
+- codiumai/pr-agent:0.8-github_app
+- codiumai/pr-agent:0.8-bitbucket-app
+- codiumai/pr-agent:0.8-gitlab_webhook
+- codiumai/pr-agent:0.8-github_polling
+- codiumai/pr-agent:0.8-github_action
+
+### Added::Algo
+
+- GitHub Action: Can control which tools will run automatically when a new PR is created. (see usage guide: https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action)
+- Code suggestion tool: Will try to avoid an 'add comments' suggestion  (see https://github.com/Codium-ai/pr-agent/pull/327)
+
+### Fixed
+
+- Gitlab: Fixed a bug of improper usage of pr_id
+
+## [Version 0.7] - 2023-09-20
+
+### Docker Tags
+
+- codiumai/pr-agent:0.7
+- codiumai/pr-agent:0.7-github_app
+- codiumai/pr-agent:0.7-bitbucket-app
+- codiumai/pr-agent:0.7-gitlab_webhook
+- codiumai/pr-agent:0.7-github_polling
+- codiumai/pr-agent:0.7-github_action
+
+### Added::Algo
+
+- New tool /similar_issue - Currently on GitHub app and CLI: indexes the issues in the repo, find the most similar issues to the target issue.
+- Describe markers: Empower the /describe tool with a templating capability (see more details in https://github.com/Codium-ai/pr-agent/pull/273).
+- New feature in the /review tool - added an estimated effort estimation to the review (https://github.com/Codium-ai/pr-agent/pull/306).
+
+### Added::Infrastructure
+
+- Implementation of a GitLab webhook.
+- Implementation of a BitBucket app.
+
+### Fixed
+
+- Protection against no code suggestions generated.
+- Resilience to repositories where the languages cannot be automatically detected.

SECURITY.md

@@ -0,0 +1,64 @@
+# Security Policy
+
+PR-Agent is an open-source tool to help efficiently review and handle pull requests. Qodo Merge is a paid version of PR-Agent, designed for companies and teams that require additional features and capabilities.
+
+This document describes the security policy of PR-Agent. For Qodo Merge's security policy, see [here](https://qodo-merge-docs.qodo.ai/overview/data_privacy/#qodo-merge).
+
+## PR-Agent Self-Hosted Solutions
+
+When using PR-Agent with your OpenAI (or other LLM provider) API key, the security relationship is directly between you and the provider. We do not send your code to Qodo servers.
+
+Types of [self-hosted solutions](https://qodo-merge-docs.qodo.ai/installation):
+
+- Locally
+- GitHub integration
+- GitLab integration
+- BitBucket integration
+- Azure DevOps integration
+
+## PR-Agent Supported Versions
+
+This section outlines which versions of PR-Agent are currently supported with security updates.
+
+### Docker Deployment Options
+
+#### Latest Version
+
+For the most recent updates, use our latest Docker image which is automatically built nightly:
+
+```yaml
+uses: qodo-ai/pr-agent@main
+```
+
+#### Specific Release Version
+
+For a fixed version, you can pin your action to a specific release version. Browse available releases at:
+[PR-Agent Releases](https://github.com/qodo-ai/pr-agent/releases)
+
+For example, to github action:
+
+```yaml
+steps:
+  - name: PR Agent action step
+    id: pragent
+    uses: docker://codiumai/pr-agent:0.26-github_action
+```
+
+#### Enhanced Security with Docker Digest
+
+For maximum security, you can specify the Docker image using its digest:
+
+```yaml
+steps:
+  - name: PR Agent action step
+    id: pragent
+    uses: docker://codiumai/pr-agent@sha256:14165e525678ace7d9b51cda8652c2d74abb4e1d76b57c4a6ccaeba84663cc64
+```
+
+## Reporting a Vulnerability
+
+We take the security of PR-Agent seriously. If you discover a security vulnerability, please report it immediately to:
+
+Email: tal.r@qodo.ai
+
+Please include a description of the vulnerability, steps to reproduce, and the affected PR-Agent version.

action.yaml

@@ -0,0 +1,8 @@
+name: 'Codium PR Agent'
+description: 'Summarize, review and suggest improvements for pull requests'
+branding:
+  icon: 'award'
+  color: 'green'
+runs:
+  using: 'docker'
+  image: 'Dockerfile.github_action_dockerhub'

codecov.yml

@@ -0,0 +1,5 @@
+comment: false
+coverage:
+  status:
+    patch: false
+    project: false

docker/Dockerfile

@@ -1,20 +1,44 @@
-FROM python:3.10 as base
+FROM python:3.12.10-slim AS base
+
+RUN apt update && apt install --no-install-recommends -y git curl && apt-get clean && rm -rf /var/lib/apt/lists/*
 
 WORKDIR /app
+ADD pyproject.toml .
 ADD requirements.txt .
-RUN pip install -r requirements.txt && rm requirements.txt
+ADD docs docs
+RUN pip install --no-cache-dir . && rm pyproject.toml requirements.txt
 ENV PYTHONPATH=/app
+
+FROM base AS github_app
 ADD pr_agent pr_agent
+CMD ["python", "-m", "gunicorn", "-k", "uvicorn.workers.UvicornWorker", "-c", "pr_agent/servers/gunicorn_config.py", "--forwarded-allow-ips", "*", "pr_agent.servers.github_app:app"]
 
-FROM base as github_app
-CMD ["python", "pr_agent/servers/github_app.py"]
+FROM base AS bitbucket_app
+ADD pr_agent pr_agent
+CMD ["python", "pr_agent/servers/bitbucket_app.py"]
 
-FROM base as github_polling
+FROM base AS bitbucket_server_webhook
+ADD pr_agent pr_agent
+CMD ["python", "pr_agent/servers/bitbucket_server_webhook.py"]
+
+FROM base AS github_polling
+ADD pr_agent pr_agent
 CMD ["python", "pr_agent/servers/github_polling.py"]
 
-FROM base as test
-ADD requirements-dev.txt .
-RUN pip install -r requirements-dev.txt && rm requirements-dev.txt
+FROM base AS gitlab_webhook
+ADD pr_agent pr_agent
+CMD ["python", "pr_agent/servers/gitlab_webhook.py"]
 
-FROM base as cli
+FROM base AS azure_devops_webhook
+ADD pr_agent pr_agent
+CMD ["python", "pr_agent/servers/azuredevops_server_webhook.py"]
+
+FROM base AS test
+ADD requirements-dev.txt .
+RUN pip install --no-cache-dir -r requirements-dev.txt && rm requirements-dev.txt
+ADD pr_agent pr_agent
+ADD tests tests
+
+FROM base AS cli
+ADD pr_agent pr_agent
 ENTRYPOINT ["python", "pr_agent/cli.py"]

docker/Dockerfile.lambda

@@ -0,0 +1,12 @@
+FROM public.ecr.aws/lambda/python:3.12
+
+RUN dnf update -y && \
+    dnf install -y gcc python3-devel git && \
+    dnf clean all
+
+ADD pyproject.toml requirements.txt ./
+RUN pip install --no-cache-dir . && rm pyproject.toml
+RUN pip install --no-cache-dir mangum==0.17.0
+COPY pr_agent/ ${LAMBDA_TASK_ROOT}/pr_agent/
+
+CMD ["pr_agent.servers.serverless.serverless"]

docs/README.md

@@ -0,0 +1 @@
+# [Visit Our Docs Portal](https://qodo-merge-docs.qodo.ai/)

docs/docs/CNAME

@@ -0,0 +1 @@
+qodo-merge-docs.qodo.ai

docs/docs/ai_search/index.md

@@ -0,0 +1,315 @@
+<div class="search-section">
+    <h1>AI Docs Search</h1>
+    <p class="search-description">
+        Search through our documentation using AI-powered natural language queries.
+    </p>
+    <div class="search-container">
+        <input
+            type="text"
+            id="searchInput"
+            class="search-input"
+            placeholder="Enter your search term..."
+        >
+        <button id="searchButton" class="search-button">Search</button>
+    </div>
+    <div id="spinner" class="spinner-container" style="display: none;">
+        <div class="spinner"></div>
+    </div>
+    <div id="results" class="results-container"></div>
+</div>
+
+<style>
+Untitled
+.search-section {
+    max-width: 800px;
+    margin: 0 auto;
+    padding: 0 1rem 2rem;
+}
+
+h1 {
+    color: #666;
+    font-size: 2.125rem;
+    font-weight: normal;
+    margin-bottom: 1rem;
+}
+
+.search-description {
+    color: #666;
+    font-size: 1rem;
+    line-height: 1.5;
+    margin-bottom: 2rem;
+    max-width: 800px;
+}
+
+.search-container {
+    display: flex;
+    gap: 1rem;
+    max-width: 800px;
+    margin: 0;  /* Changed from auto to 0 to align left */
+}
+
+.search-input {
+    flex: 1;
+    padding: 0 0.875rem;
+    border: 1px solid #ddd;
+    border-radius: 4px;
+    font-size: 0.9375rem;
+    outline: none;
+    height: 40px;  /* Explicit height */
+}
+
+.search-input:focus {
+    border-color: #6c63ff;
+}
+
+.search-button {
+    padding: 0 1.25rem;
+    background-color: #2196F3;
+    color: white;
+    border: none;
+    border-radius: 4px;
+    cursor: pointer;
+    font-size: 0.875rem;
+    transition: background-color 0.2s;
+    height: 40px;  /* Match the height of search input */
+    display: flex;
+    align-items: center;
+    justify-content: center;
+}
+
+.search-button:hover {
+    background-color: #1976D2;
+}
+
+.spinner-container {
+    display: flex;
+    justify-content: center;
+    margin-top: 2rem;
+}
+
+.spinner {
+    width: 40px;
+    height: 40px;
+    border: 4px solid #f3f3f3;
+    border-top: 4px solid #2196F3;
+    border-radius: 50%;
+    animation: spin 1s linear infinite;
+}
+
+@keyframes spin {
+    0% { transform: rotate(0deg); }
+    100% { transform: rotate(360deg); }
+}
+
+.results-container {
+    margin-top: 2rem;
+    max-width: 800px;
+}
+
+.result-item {
+    padding: 1rem;
+    border: 1px solid #ddd;
+    border-radius: 4px;
+    margin-bottom: 1rem;
+}
+
+.result-title {
+    font-size: 1.2rem;
+    color: #2196F3;
+    margin-bottom: 0.5rem;
+}
+
+.result-description {
+    color: #666;
+}
+
+.error-message {
+    color: #dc3545;
+    padding: 1rem;
+    border: 1px solid #dc3545;
+    border-radius: 4px;
+    margin-top: 1rem;
+}
+
+.markdown-content {
+    line-height: 1.6;
+    color: var(--md-typeset-color);
+    background: var(--md-default-bg-color);
+    border: 1px solid var(--md-default-fg-color--lightest);
+    border-radius: 12px;
+    padding: 1.5rem;
+    box-shadow: 0 2px 4px rgba(0,0,0,0.05);
+    position: relative;
+    margin-top: 2rem;
+}
+
+.markdown-content::before {
+    content: '';
+    position: absolute;
+    top: -8px;
+    left: 24px;
+    width: 16px;
+    height: 16px;
+    background: var(--md-default-bg-color);
+    border-left: 1px solid var(--md-default-fg-color--lightest);
+    border-top: 1px solid var(--md-default-fg-color--lightest);
+    transform: rotate(45deg);
+}
+
+.markdown-content > *:first-child {
+    margin-top: 0;
+    padding-top: 0;
+}
+
+.markdown-content p {
+    margin-bottom: 1rem;
+}
+
+.markdown-content p:last-child {
+    margin-bottom: 0;
+}
+
+.markdown-content code {
+    background: var(--md-code-bg-color);
+    color: var(--md-code-fg-color);
+    padding: 0.2em 0.4em;
+    border-radius: 3px;
+    font-size: 0.9em;
+    font-family: ui-monospace, SFMono-Regular, SF Mono, Menlo, Consolas, Liberation Mono, monospace;
+}
+
+.markdown-content pre {
+    background: var(--md-code-bg-color);
+    padding: 1rem;
+    border-radius: 6px;
+    overflow-x: auto;
+    margin: 1rem 0;
+}
+
+.markdown-content pre code {
+    background: none;
+    padding: 0;
+    font-size: 0.9em;
+}
+
+[data-md-color-scheme="slate"] .markdown-content {
+    box-shadow: 0 2px 4px rgba(0,0,0,0.1);
+}
+
+</style>
+
+<script src="https://cdnjs.cloudflare.com/ajax/libs/marked/9.1.6/marked.min.js"></script>
+
+<script>
+window.addEventListener('load', function() {
+    function displayResults(responseText) {
+        const resultsContainer = document.getElementById('results');
+        const spinner = document.getElementById('spinner');
+        const searchContainer = document.querySelector('.search-container');
+
+        // Hide spinner
+        spinner.style.display = 'none';
+
+        // Scroll to search bar
+        searchContainer.scrollIntoView({ behavior: 'smooth', block: 'start' });
+
+        try {
+            const results = JSON.parse(responseText);
+
+            marked.setOptions({
+                breaks: true,
+                gfm: true,
+                headerIds: false,
+                sanitize: false
+            });
+
+            const htmlContent = marked.parse(results.message);
+
+            resultsContainer.className = 'markdown-content';
+            resultsContainer.innerHTML = htmlContent;
+
+            // Scroll after content is rendered
+            setTimeout(() => {
+                const searchContainer = document.querySelector('.search-container');
+                const offset = 55; // Offset from top in pixels
+                const elementPosition = searchContainer.getBoundingClientRect().top;
+                const offsetPosition = elementPosition + window.pageYOffset - offset;
+
+                window.scrollTo({
+                    top: offsetPosition,
+                    behavior: 'smooth'
+                });
+            }, 100);
+        } catch (error) {
+            console.error('Error parsing results:', error);
+            resultsContainer.innerHTML = '<div class="error-message">Error processing results</div>';
+        }
+    }
+
+    async function performSearch() {
+        const searchInput = document.getElementById('searchInput');
+        const resultsContainer = document.getElementById('results');
+        const spinner = document.getElementById('spinner');
+        const searchTerm = searchInput.value.trim();
+
+        if (!searchTerm) {
+            resultsContainer.innerHTML = '<div class="error-message">Please enter a search term</div>';
+            return;
+        }
+
+        // Show spinner, clear results
+        spinner.style.display = 'flex';
+        resultsContainer.innerHTML = '';
+
+        try {
+            const data = {
+                "query": searchTerm
+            };
+
+            const options = {
+                method: 'POST',
+                headers: {
+                    'accept': 'text/plain',
+                    'content-type': 'application/json',
+                },
+                body: JSON.stringify(data)
+            };
+
+            // const API_ENDPOINT = 'http://0.0.0.0:3000/api/v1/docs_help';
+            const API_ENDPOINT = 'https://help.merge.qodo.ai/api/v1/docs_help';
+
+            const response = await fetch(API_ENDPOINT, options);
+
+            if (!response.ok) {
+                throw new Error(`HTTP error! status: ${response.status}`);
+            }
+
+            const responseText = await response.text();
+            displayResults(responseText);
+        } catch (error) {
+            spinner.style.display = 'none';
+            resultsContainer.innerHTML = `
+                <div class="error-message">
+                    An error occurred while searching. Please try again later.
+                </div>
+            `;
+        }
+    }
+
+    // Add event listeners
+    const searchButton = document.getElementById('searchButton');
+    const searchInput = document.getElementById('searchInput');
+
+    if (searchButton) {
+        searchButton.addEventListener('click', performSearch);
+    }
+
+    if (searchInput) {
+        searchInput.addEventListener('keypress', function(e) {
+            if (e.key === 'Enter') {
+                performSearch();
+            }
+        });
+    }
+});
+</script>

docs/docs/chrome-extension/data_privacy.md

@@ -0,0 +1,4 @@
+We take your code's security and privacy seriously:
+
+- The Chrome extension will not send your code to any external servers.
+- For private repositories, we will first validate the user's identity and permissions. After authentication, we generate responses using the existing Qodo Merge integration.

docs/docs/chrome-extension/features.md

@@ -0,0 +1,49 @@
+
+### PR chat
+
+The PR-Chat feature allows to freely chat with your PR code, within your GitHub environment.
+It will seamlessly use the PR as context to your chat session, and provide AI-powered feedback.
+
+To enable private chat, simply install the Qodo Merge Chrome extension. After installation, each PR's file-changed tab will include a chat box, where you may ask questions about your code.
+This chat session is **private**, and won't be visible to other users.
+
+All open-source repositories are supported.
+For private repositories, you will also need to install Qodo Merge. After installation, make sure to open at least one new PR to fully register your organization. Once done, you can chat with both new and existing PRs across all installed repositories.
+
+#### Context-aware PR chat
+
+Qodo Merge constructs a comprehensive context for each pull request, incorporating the PR description, commit messages, and code changes with extended dynamic context. This contextual information, along with additional PR-related data, forms the foundation for an AI-powered chat session. The agent then leverages this rich context to provide intelligent, tailored responses to user inquiries about the pull request.
+
+<img src="https://codium.ai/images/pr_agent/pr_chat_1.png" width="768">
+<img src="https://codium.ai/images/pr_agent/pr_chat_2.png" width="768">
+
+### Toolbar extension
+
+With Qodo Merge Chrome extension, it's [easier than ever](https://www.youtube.com/watch?v=gT5tli7X4H4) to interactively configure and experiment with the different tools and configuration options.
+
+For private repositories, after you found the setup that works for you, you can also easily export it as a persistent configuration file, and use it for automatic commands.
+
+<img src="https://codium.ai/images/pr_agent/toolbar1.png" width="512">
+
+<img src="https://codium.ai/images/pr_agent/toolbar2.png" width="512">
+
+### Qodo Merge filters
+
+Qodo Merge filters is a sidepanel option. that allows you to filter different message in the conversation tab.
+
+For example, you can choose to present only message from Qodo Merge, or filter those messages, focusing only on user's comments.
+
+<img src="https://codium.ai/images/pr_agent/pr_agent_filters1.png" width="256">
+
+<img src="https://codium.ai/images/pr_agent/pr_agent_filters2.png" width="256">
+
+### Enhanced code suggestions
+
+Qodo Merge Chrome extension adds the following capabilities to code suggestions tool's comments:
+
+- Auto-expand the table when you are viewing a code block, to avoid clipping.
+- Adding a "quote-and-reply" button, that enables to address and comment on a specific suggestion (for example, asking the author to fix the issue)
+
+<img src="https://codium.ai/images/pr_agent/chrome_extension_code_suggestion1.png" width="512">
+
+<img src="https://codium.ai/images/pr_agent/chrome_extension_code_suggestion2.png" width="512">

docs/docs/chrome-extension/index.md

@@ -0,0 +1,14 @@
+[Qodo Merge Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl){:target="_blank"} is a collection of tools that integrates seamlessly with your GitHub environment, aiming to enhance your Git usage experience, and providing AI-powered capabilities to your PRs.
+
+With a single-click installation you will gain access to a context-aware chat on your pull requests code, a toolbar extension with multiple AI feedbacks, Qodo Merge filters, and additional abilities.
+
+The extension is powered by top code models like Claude 3.7 Sonnet and o4-mini. All the extension's features are free to use on public repositories.
+
+For private repositories, you will need to install [Qodo Merge](https://github.com/apps/qodo-merge-pro){:target="_blank"} in addition to the extension  (Quick GitHub app setup with a 14-day free trial. No credit card needed).
+For a demonstration of how to install Qodo Merge and use it with the Chrome extension, please refer to the tutorial video at the provided [link](https://codium.ai/images/pr_agent/private_repos.mp4){:target="_blank"}.
+
+<img src="https://codium.ai/images/pr_agent/PR-AgentChat.gif" width="768">
+
+### Supported browsers
+
+The extension is supported on all Chromium-based browsers, including Google Chrome, Arc, Opera, Brave, and Microsoft Edge.

docs/docs/chrome-extension/options.md

@@ -0,0 +1,39 @@
+## Options and Configurations
+
+### Accessing the Options Page
+
+To access the options page for the Qodo Merge Chrome extension:
+
+1. Find the extension icon in your Chrome toolbar (usually in the top-right corner of your browser)
+2. Right-click on the extension icon
+3. Select "Options" from the context menu that appears
+
+Alternatively, you can access the options page directly using this URL:
+
+[chrome-extension://ephlnjeghhogofkifjloamocljapahnl/options.html](chrome-extension://ephlnjeghhogofkifjloamocljapahnl/options.html)
+
+<img src="https://codium.ai/images/pr_agent/chrome_ext_options.png" width="256">
+
+### Configuration Options
+
+<img src="https://codium.ai/images/pr_agent/chrome_ext_settings_page.png" width="512">
+
+#### API Base Host
+
+For single-tenant customers, you can configure the extension to communicate directly with your company's Qodo Merge server instance.
+
+To set this up:
+
+- Enter your organization's Qodo Merge API endpoint in the "API Base Host" field
+- This endpoint should be provided by your Qodo DevOps Team
+
+*Note: The extension does not send your code to the server, but only triggers your previously installed Qodo Merge application.*
+
+#### Interface Options
+
+You can customize the extension's interface by:
+
+- Toggling the "Show Qodo Merge Toolbar" option
+- When disabled, the toolbar will not appear in your Github comment bar
+
+Remember to click "Save Settings" after making any changes.

docs/docs/core-abilities/auto_best_practices.md

@@ -0,0 +1,67 @@
+# Auto Best Practices 💎
+
+`Supported Git Platforms: GitHub`
+
+## Overview
+
+![Auto best practice suggestion graph](https://www.qodo.ai/images/pr_agent/auto_best_practices_graph.png){width=684}
+
+> Note - enabling a [Wiki](https://qodo-merge-docs.qodo.ai/usage-guide/enabling_a_wiki/) is required for this feature.
+
+### Finding Code Problems - Exploration Phase
+
+The `improve` tool identifies potential issues, problems and bugs in Pull Request (PR) code changes.
+Rather than focusing on minor issues like code style or formatting, the tool intelligently analyzes code to detect meaningful problems.
+
+The analysis intentionally takes a flexible, _exploratory_ approach to identify meaningful potential issues, allowing the tool to surface relevant code suggestions without being constrained by predefined categories.
+
+### Tracking Implemented Suggestions
+
+Qodo Merge features a novel [tracking system](https://qodo-merge-docs.qodo.ai/tools/improve/#suggestion-tracking) that automatically detects when PR authors implement AI-generated code suggestions.
+All accepted suggestions are aggregated in a repository-specific wiki page called [`.pr_agent_accepted_suggestions`](https://github.com/qodo-ai/pr-agent/wiki/.pr_agent_accepted_suggestions)
+
+### Learning and Applying Auto Best Practices
+
+Monthly, Qodo Merge analyzes the collection of accepted suggestions to generate repository-specific best practices, stored in [`.pr_agent_auto_best_practices`](https://github.com/qodo-ai/pr-agent/wiki/.pr_agent_auto_best_practices) wiki file.
+These best practices reflect recurring patterns in accepted code improvements.
+
+The `improve` tool will incorporate these best practices as an additional analysis layer, checking PR code changes against known patterns of previously accepted improvements.
+This creates a two-phase analysis:
+
+1. Open exploration for general code issues
+2. Targeted checking against established best practices - exploiting the knowledge gained from past suggestions
+
+By keeping these phases decoupled, the tool remains free to discover new or unseen issues and problems, while also learning from past experiences.
+
+When presenting the suggestions generated by the `improve` tool, Qodo Merge will add a dedicated label for each suggestion generated from the auto best practices - 'Learned best practice':
+
+![Auto best practice suggestion](https://www.qodo.ai/images/pr_agent/auto_best_practices.png){width=684}
+
+## Auto Best Practices vs Custom Best Practices
+
+Teams and companies can also manually define their own [custom best practices](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) in Qodo Merge.
+
+When custom best practices exist, Qodo Merge will still generate an 'auto best practices' wiki file, though it won't be used by the `improve` tool.
+However, this auto-generated file can still serve two valuable purposes:
+
+1. It can help enhance your custom best practices with additional insights derived from suggestions your team found valuable enough to implement
+2. It demonstrates effective patterns for writing AI-friendly best practices
+
+Even when using custom best practices, we recommend regularly reviewing the auto best practices file to refine your custom rules.
+
+## Relevant configurations
+
+```toml
+[auto_best_practices]
+# Disable all auto best practices usage or generation
+enable_auto_best_practices = true  
+
+# Disable usage of auto best practices file in the 'improve' tool
+utilize_auto_best_practices = true 
+
+# Extra instructions to the auto best practices generation prompt
+extra_instructions = ""            
+
+# Max number of patterns to be detected
+max_patterns = 5                   
+```

docs/docs/core-abilities/code_validation.md

@@ -0,0 +1,40 @@
+## Introduction
+
+The Git environment usually represents the final stage before code enters production. Hence, Detecting bugs and issues during the review process is critical.
+
+The [`improve`](https://qodo-merge-docs.qodo.ai/tools/improve/) tool provides actionable code suggestions for your pull requests, aiming to help detect and fix bugs and problems.
+By default, suggestions appear as a comment in a table format:
+
+![code_suggestions_as_comment_closed.png](https://codium.ai/images/pr_agent/code_suggestions_as_comment_closed.png){width=512}
+
+![code_suggestions_as_comment_open.png](https://codium.ai/images/pr_agent/code_suggestions_as_comment_open.png){width=512}
+
+## Validation of Code Suggestions
+
+Each suggestion in the table can be "applied" by clicking on the `Apply this suggestion` checkbox, converting it to a committable Git code change that can be committed directly to the PR.
+This approach allows to fix issues without returning to your IDE for manual edits — significantly faster and more convenient.
+
+However, committing a suggestion in a Git environment carries more risk than in a local IDE, as you don't have the opportunity to fully run and test the code before committing.
+
+To balance convenience with safety, Qodo Merge implements a dual validation system for each generated code suggestion:
+
+1) **Localization** - Qodo Merge confirms that the suggestion's line numbers and surrounding code, as predicted by the model, actually match the repo code. This means that the model correctly identified the context and location of the code to be changed.
+
+2) **"Compilation"** - Using static code analysis, Qodo Merge verifies that after applying the suggestion, the modified file will still be valid, meaning tree-sitter syntax processing will not throw an error. This process is relevant for multiple programming languages, see [here](https://pypi.org/project/tree-sitter-languages/) for the full list of supported languages.
+
+When a suggestion fails to meet these validation criteria, it may still provide valuable feedback, but isn't suitable for direct application to the PR.
+In such cases, Qodo Merge will omit the 'apply' checkbox and instead display:
+
+`[To ensure code accuracy, apply this suggestion manually]`
+
+All suggestions that pass these validations undergo a final stage of **self-reflection**, where the AI model evaluates, scores, and re-ranks its own suggestions, eliminating any that are irrelevant or incorrect.
+Read more about this process in the [self-reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/) page.
+
+## Conclusion
+
+The validation methods described above enhance the reliability of code suggestions and help PR authors determine which suggestions are safer to apply in the Git environment.
+Of course, additional factors should be considered, such as suggestion complexity and potential code impact.
+
+Human judgment remains essential. After clicking 'apply', Qodo Merge still presents the 'before' and 'after' code snippets for review, allowing you to assess the changes before finalizing the commit.
+
+![improve](https://codium.ai/images/pr_agent/improve.png){width=512}

docs/docs/core-abilities/compression_strategy.md

@@ -0,0 +1,54 @@
+
+## Overview - PR Compression Strategy
+
+There are two scenarios:
+
+1. The PR is small enough to fit in a single prompt (including system and user prompt)
+2. The PR is too large to fit in a single prompt (including system and user prompt)
+
+For both scenarios, we first use the following strategy
+
+#### Repo language prioritization strategy
+
+We prioritize the languages of the repo based on the following criteria:
+
+1. Exclude binary files and non code files (e.g. images, pdfs, etc)
+2. Given the main languages used in the repo
+3. We sort the PR files by the most common languages in the repo (in descending order):
+   * ```[[file.py, file2.py],[file3.js, file4.jsx],[readme.md]]```
+
+### Small PR
+
+In this case, we can fit the entire PR in a single prompt:
+
+1. Exclude binary files and non code files (e.g. images, pdfs, etc)
+2. We Expand the surrounding context of each patch to 3 lines above and below the patch
+
+### Large PR
+
+#### Motivation
+
+Pull Requests can be very long and contain a lot of information with varying degree of relevance to the pr-agent.
+We want to be able to pack as much information as possible in a single LMM prompt, while keeping the information relevant to the pr-agent.
+
+#### Compression strategy
+
+We prioritize additions over deletions:
+
+* Combine all deleted files into a single list (`deleted files`)
+* File patches are a list of hunks, remove all hunks of type deletion-only from the hunks in the file patch
+
+#### Adaptive and token-aware file patch fitting
+
+We use [tiktoken](https://github.com/openai/tiktoken) to tokenize the patches after the modifications described above, and we use the following strategy to fit the patches into the prompt:
+
+1. Within each language we sort the files by the number of tokens in the file (in descending order):
+    * ```[[file2.py, file.py],[file4.jsx, file3.js],[readme.md]]```
+2. Iterate through the patches in the order described above
+3. Add the patches to the prompt until the prompt reaches a certain buffer from the max token length
+4. If there are still patches left, add the remaining patches as a list called `other modified files` to the prompt until the prompt reaches the max token length (hard stop), skip the rest of the patches.
+5. If we haven't reached the max token length, add the `deleted files` to the prompt until the prompt reaches the max token length (hard stop), skip the rest of the patches.
+
+#### Example
+
+![Core Abilities](https://codium.ai/images/git_patch_logic.png){width=768}

docs/docs/core-abilities/dynamic_context.md

@@ -0,0 +1,74 @@
+## TL;DR
+
+Qodo Merge uses an **asymmetric and dynamic context strategy** to improve AI analysis of code changes in pull requests.
+It provides more context before changes than after, and dynamically adjusts the context based on code structure (e.g., enclosing functions or classes).
+This approach balances providing sufficient context for accurate analysis, while avoiding needle-in-the-haystack information overload that could degrade AI performance or exceed token limits.
+
+## Introduction
+
+Pull request code changes are retrieved in a unified diff format, showing three lines of context before and after each modified section, with additions marked by '+' and deletions by '-'.
+
+```diff
+@@ -12,5 +12,5 @@ def func1():
+ code line that already existed in the file...
+ code line that already existed in the file...
+ code line that already existed in the file....
+-code line that was removed in the PR
++new code line added in the PR
+ code line that already existed in the file...
+ code line that already existed in the file...
+ code line that already existed in the file...
+
+@@ -26,2 +26,4 @@ def func2():
+...
+```
+
+This unified diff format can be challenging for AI models to interpret accurately, as it provides limited context for understanding the full scope of code changes.
+The presentation of code using '+', '-', and ' ' symbols to indicate additions, deletions, and unchanged lines respectively also differs from the standard code formatting typically used to train AI models.
+
+## Challenges of expanding the context window
+
+While expanding the context window is technically feasible, it presents a more fundamental trade-off:
+
+Pros:
+
+- Enhanced context allows the model to better comprehend and localize the code changes, results (potentially) in more precise analysis and suggestions. Without enough context, the model may struggle to understand the code changes and provide relevant feedback.
+
+Cons:
+
+- Excessive context may overwhelm the model with extraneous information, creating a "needle in a haystack" scenario where focusing on the relevant details (the code that actually changed) becomes challenging.
+LLM quality is known to degrade when the context gets larger.
+Pull requests often encompass multiple changes across many files, potentially spanning hundreds of lines of modified code. This complexity presents a genuine risk of overwhelming the model with excessive context.
+
+- Increased context expands the token count, increasing processing time and cost, and may prevent the model from processing the entire pull request in a single pass.
+
+## Asymmetric and dynamic context
+
+To address these challenges, Qodo Merge employs an **asymmetric** and **dynamic** context strategy, providing the model with more focused and relevant context information for each code change.
+
+**Asymmetric:**
+
+We start by recognizing that the context preceding a code change is typically more crucial for understanding the modification than the context following it.
+Consequently, Qodo Merge implements an asymmetric context policy, decoupling the context window into two distinct segments: one for the code before the change and another for the code after.
+
+By independently adjusting each context window, Qodo Merge can supply the model with a more tailored and pertinent context for individual code changes.
+
+**Dynamic:**
+
+We also employ a "dynamic" context strategy.
+We start by recognizing that the optimal context for a code change often corresponds to its enclosing code component (e.g., function, class), rather than a fixed number of lines.
+Consequently, we dynamically adjust the context window based on the code's structure, ensuring the model receives the most pertinent information for each modification.
+
+To prevent overwhelming the model with excessive context, we impose a limit on the number of lines searched when identifying the enclosing component.
+This balance allows for comprehensive understanding while maintaining efficiency and limiting context token usage.
+
+## Appendix - relevant configuration options
+
+```toml
+[config]
+patch_extension_skip_types =[".md",".txt"]  # Skip files with these extensions when trying to extend the context
+allow_dynamic_context=true                  # Allow dynamic context extension
+max_extra_lines_before_dynamic_context = 8  # will try to include up to X extra lines before the hunk in the patch, until we reach an enclosing function or class
+patch_extra_lines_before = 3                # Number of extra lines (+3 default ones) to include before each hunk in the patch
+patch_extra_lines_after = 1                 # Number of extra lines (+3 default ones) to include after each hunk in the patch
+```

docs/docs/core-abilities/fetching_ticket_context.md

@@ -0,0 +1,302 @@
+# Fetching Ticket Context for PRs
+
+`Supported Git Platforms: GitHub, GitLab, Bitbucket`
+
+## Overview
+
+Qodo Merge streamlines code review workflows by seamlessly connecting with multiple ticket management systems.
+This integration enriches the review process by automatically surfacing relevant ticket information and context alongside code changes.
+
+**Ticket systems supported**:
+
+- GitHub
+- Jira (💎)
+
+**Ticket data fetched:**
+
+1. Ticket Title
+2. Ticket Description
+3. Custom Fields (Acceptance criteria)
+4. Subtasks (linked tasks)
+5. Labels
+6. Attached Images/Screenshots
+
+## Affected Tools
+
+Ticket Recognition Requirements:
+
+- The PR description should contain a link to the ticket or if the branch name starts with the ticket id / number.
+- For Jira tickets, you should follow the instructions in [Jira Integration](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#jira-integration) in order to authenticate with Jira.
+
+### Describe tool
+
+Qodo Merge will recognize the ticket and use the ticket content (title, description, labels) to provide additional context for the code changes.
+By understanding the reasoning and intent behind modifications, the LLM can offer more insightful and relevant code analysis.
+
+### Review tool
+
+Similarly to the `describe` tool, the `review` tool will use the ticket content to provide additional context for the code changes.
+
+In addition, this feature will evaluate how well a Pull Request (PR) adheres to its original purpose/intent as defined by the associated ticket or issue mentioned in the PR description.
+Each ticket will be assigned a label (Compliance/Alignment level), Indicates the degree to which the PR fulfills its original purpose, Options: Fully compliant, Partially compliant or Not compliant.
+
+![Ticket Compliance](https://www.qodo.ai/images/pr_agent/ticket_compliance_review.png){width=768}
+
+By default, the tool will automatically validate if the PR complies with the referenced ticket.
+If you want to disable this feedback, add the following line to your configuration file:
+
+```toml
+[pr_reviewer]
+require_ticket_analysis_review=false
+```
+
+## GitHub Issues Integration
+
+Qodo Merge will automatically recognize GitHub issues mentioned in the PR description and fetch the issue content.
+Examples of valid GitHub issue references:
+
+- `https://github.com/<ORG_NAME>/<REPO_NAME>/issues/<ISSUE_NUMBER>`
+- `#<ISSUE_NUMBER>`
+- `<ORG_NAME>/<REPO_NAME>#<ISSUE_NUMBER>`
+
+Since Qodo Merge is integrated with GitHub, it doesn't require any additional configuration to fetch GitHub issues.
+
+## Jira Integration 💎
+
+We support both Jira Cloud and Jira Server/Data Center.
+
+### Jira Cloud
+
+There are two ways to authenticate with Jira Cloud:
+
+**1) Jira App Authentication**
+
+The recommended way to authenticate with Jira Cloud is to install the Qodo Merge app in your Jira Cloud instance. This will allow Qodo Merge to access Jira data on your behalf.
+
+Installation steps:
+
+1. Click [here](https://auth.atlassian.com/authorize?audience=api.atlassian.com&client_id=8krKmA4gMD8mM8z24aRCgPCSepZNP1xf&scope=read%3Ajira-work%20offline_access&redirect_uri=https%3A%2F%2Fregister.jira.pr-agent.codium.ai&state=qodomerge&response_type=code&prompt=consent) to install the Qodo Merge app in your Jira Cloud instance, click the `accept` button.<br>
+![Jira Cloud App Installation](https://www.qodo.ai/images/pr_agent/jira_app_installation1.png){width=384}
+
+2. After installing the app, you will be redirected to the Qodo Merge registration page. and you will see a success message.<br>
+![Jira Cloud App success message](https://www.qodo.ai/images/pr_agent/jira_app_success.png){width=384}
+
+3. Now Qodo Merge will be able to fetch Jira ticket context for your PRs.
+
+**2) Email/Token Authentication**
+
+You can create an API token from your Atlassian account:
+
+1. Log in to https://id.atlassian.com/manage-profile/security/api-tokens.
+
+2. Click Create API token.
+
+3. From the dialog that appears, enter a name for your new token and click Create.
+
+4. Click Copy to clipboard.
+
+![Jira Cloud API Token](https://images.ctfassets.net/zsv3d0ugroxu/1RYvh9lqgeZjjNe5S3Hbfb/155e846a1cb38f30bf17512b6dfd2229/screenshot_NewAPIToken){width=384}
+
+5. In your [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) add the following lines:
+
+```toml
+[jira]
+jira_api_token = "YOUR_API_TOKEN"
+jira_api_email = "YOUR_EMAIL"
+```
+
+### Jira Data Center/Server
+
+[//]: # ()
+[//]: # (##### Local App Authentication &#40;For Qodo Merge On-Premise Customers&#41;)
+
+[//]: # ()
+[//]: # (##### 1. Step 1: Set up an application link in Jira Data Center/Server)
+
+[//]: # (* Go to Jira Administration > Applications > Application Links > Click on `Create link`)
+
+[//]: # ()
+[//]: # (![application links]&#40;https://www.qodo.ai/images/pr_agent/jira_app_links.png&#41;{width=384})
+
+[//]: # (* Choose `External application` and set the direction to `Incoming` and then click `Continue`)
+
+[//]: # ()
+[//]: # (![external application]&#40;https://www.qodo.ai/images/pr_agent/jira_create_link.png&#41;{width=256})
+
+[//]: # (* In the following screen, enter the following details:)
+
+[//]: # (    * Name: `Qodo Merge`)
+
+[//]: # (    * Redirect URL: Enter your Qodo Merge URL followed  `https://{QODO_MERGE_ENDPOINT}/register_ticket_provider`)
+
+[//]: # (    * Permission: Select `Read`)
+
+[//]: # (    * Click `Save`)
+
+[//]: # ()
+[//]: # (![external application details]&#40;https://www.qodo.ai/images/pr_agent/jira_fill_app_link.png&#41;{width=384})
+
+[//]: # (* Copy the `Client ID` and `Client secret` and set them in your `.secrets` file:)
+
+[//]: # ()
+[//]: # (![client id and secret]&#40;https://www.qodo.ai/images/pr_agent/jira_app_credentionals.png&#41;{width=256})
+
+[//]: # (```toml)
+
+[//]: # ([jira])
+
+[//]: # (jira_app_secret = "...")
+
+[//]: # (jira_client_id = "...")
+
+[//]: # (```)
+
+[//]: # ()
+[//]: # (##### 2. Step 2: Authenticate with Jira Data Center/Server)
+
+[//]: # (* Open this URL in your browser: `https://{QODO_MERGE_ENDPOINT}/jira_auth`)
+
+[//]: # (* Click on link)
+
+[//]: # ()
+[//]: # (![jira auth success]&#40;https://www.qodo.ai/images/pr_agent/jira_auth_page.png&#41;{width=384})
+
+[//]: # ()
+[//]: # (* You will be redirected to Jira Data Center/Server, click `Allow`)
+
+[//]: # (* You will be redirected back to Qodo Merge and you will see a success message.)
+
+[//]: # (Personal Access Token &#40;PAT&#41; Authentication)
+
+#### Using Basic Authentication for Jira Data Center/Server
+
+You can use your Jira username and password to authenticate with Jira Data Center/Server.
+
+In your Configuration file/Environment variables/Secrets file, add the following lines:
+
+```toml
+jira_api_email = "your_username"
+jira_api_token = "your_password"
+```
+
+(Note that indeed the 'jira_api_email' field is used for the username, and the 'jira_api_token' field is used for the user password.)
+
+##### Validating Basic authentication via Python script
+
+If you are facing issues retrieving tickets in Qodo Merge with Basic auth, you can validate the flow using a Python script.
+This following steps will help you check if the basic auth is working correctly, and if you can access the Jira ticket details:
+
+1. run `pip install jira==3.8.0`
+
+2. run the following Python script (after replacing the placeholders with your actual values):
+
+??? example "Script to validate basic auth"
+
+    ```python
+    from jira import JIRA
+    
+    
+    if __name__ == "__main__":
+        try:
+            # Jira server URL
+            server = "https://..."
+            # Basic auth
+            username = "..."
+            password = "..."
+            # Jira ticket code (e.g. "PROJ-123")
+            ticket_id = "..."
+    
+            print("Initializing JiraServerTicketProvider with JIRA server")
+            # Initialize JIRA client
+            jira = JIRA(
+                server=server,
+                basic_auth=(username, password),
+                timeout=30
+            )
+            if jira:
+                print(f"JIRA client initialized successfully")
+            else:
+                print("Error initializing JIRA client")
+    
+            # Fetch ticket details
+            ticket = jira.issue(ticket_id)
+            print(f"Ticket title: {ticket.fields.summary}")
+    
+        except Exception as e:
+            print(f"Error fetching JIRA ticket details: {e}")
+    ```
+
+#### Using a Personal Access Token (PAT) for Jira Data Center/Server
+
+1. Create a [Personal Access Token (PAT)](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html) in your Jira account
+2. In your Configuration file/Environment variables/Secrets file, add the following lines:
+
+```toml
+[jira]
+jira_base_url = "YOUR_JIRA_BASE_URL" # e.g. https://jira.example.com
+jira_api_token = "YOUR_API_TOKEN"
+```
+
+##### Validating PAT token via Python script
+
+If you are facing issues retrieving tickets in Qodo Merge with PAT token, you can validate the flow using a Python script.
+This following steps will help you check if the token is working correctly, and if you can access the Jira ticket details:
+
+1. run `pip install jira==3.8.0`
+
+2. run the following Python script (after replacing the placeholders with your actual values):
+
+??? example "Script to validate PAT token"
+
+    ```python
+    from jira import JIRA
+    
+    
+    if __name__ == "__main__":
+        try:
+            # Jira server URL
+            server = "https://..."
+            # Jira PAT token
+            token_auth = "..."
+            # Jira ticket code (e.g. "PROJ-123")
+            ticket_id = "..."
+    
+            print("Initializing JiraServerTicketProvider with JIRA server")
+            # Initialize JIRA client
+            jira = JIRA(
+                server=server,
+                token_auth=token_auth,
+                timeout=30
+            )
+            if jira:
+                print(f"JIRA client initialized successfully")
+            else:
+                print("Error initializing JIRA client")
+    
+            # Fetch ticket details
+            ticket = jira.issue(ticket_id)
+            print(f"Ticket title: {ticket.fields.summary}")
+    
+        except Exception as e:
+            print(f"Error fetching JIRA ticket details: {e}")
+    ```
+
+### How to link a PR to a Jira ticket
+
+To integrate with Jira, you can link your PR to a ticket using either of these methods:
+
+**Method 1: Description Reference:**
+
+Include a ticket reference in your PR description using either the complete URL format https://<JIRA_ORG>.atlassian.net/browse/ISSUE-123 or the shortened ticket ID ISSUE-123.
+
+**Method 2: Branch Name Detection:**
+
+Name your branch with the ticket ID as a prefix (e.g., `ISSUE-123-feature-description` or `ISSUE-123/feature-description`).
+
+!!! note "Jira Base URL"
+    For shortened ticket IDs or branch detection (method 2 for JIRA cloud), you must configure the Jira base URL in your configuration file under the [jira] section:
+
+    ```toml
+    [jira]
+    jira_base_url = "https://<JIRA_ORG>.atlassian.net"
+    ```

docs/docs/core-abilities/impact_evaluation.md

@@ -0,0 +1,49 @@
+# Overview - Impact Evaluation 💎
+
+Demonstrating the return on investment (ROI) of AI-powered initiatives is crucial for modern organizations.
+To address this need, Qodo Merge has developed an AI impact measurement tools and metrics, providing advanced analytics to help businesses quantify the tangible benefits of AI adoption in their PR review process.
+
+## Auto Impact Validator - Real-Time Tracking of Implemented Qodo Merge Suggestions
+
+### How It Works
+
+When a user pushes a new commit to the pull request, Qodo Merge automatically compares the updated code against the previous suggestions, marking them as implemented if the changes address these recommendations, whether directly or indirectly:
+
+1. **Direct Implementation:** The user directly addresses the suggestion as-is in the PR, either by clicking on the "apply code suggestion" checkbox or by making the changes manually.
+2. **Indirect Implementation:** Qodo Merge recognizes when a suggestion's intent is fulfilled, even if the exact code changes differ from the original recommendation. It marks these suggestions as implemented, acknowledging that users may achieve the same goal through alternative solutions.
+
+### Real-Time Visual Feedback
+
+Upon confirming that a suggestion was implemented, Qodo Merge automatically adds a ✅ (check mark) to the relevant suggestion, enabling transparent tracking of Qodo Merge's impact analysis.
+Qodo Merge will also add, inside the relevant suggestions, an explanation of how the new code was impacted by each suggestion.
+
+![Suggestion_checkmark](https://codium.ai/images/pr_agent/auto_suggestion_checkmark.png){width=512}
+
+### Dashboard Metrics
+
+The dashboard provides macro-level insights into the overall impact of Qodo Merge on the pull-request process with key productivity metrics.
+
+By offering clear, data-driven evidence of Qodo Merge's impact, it empowers leadership teams to make informed decisions about the tool's effectiveness and ROI.
+
+Here are key metrics that the dashboard tracks:
+
+#### Qodo Merge Impacts per 1K Lines
+
+![Dashboard](https://codium.ai/images/pr_agent/impacts_per_1k_llines.png){width=512}
+> Explanation: for every 1K lines of code (additions/edits), Qodo Merge had on average ~X suggestions implemented.
+
+**Why This Metric Matters:**
+
+1. **Standardized and Comparable Measurement:** By measuring impacts per 1K lines of code additions, you create a standardized metric that can be compared across different projects, teams, customers, and time periods. This standardization is crucial for meaningful analysis, benchmarking, and identifying where Qodo Merge is most effective.
+2. **Accounts for PR Variability and Incentivizes Quality:** This metric addresses the fact that "Not all PRs are created equal." By normalizing against lines of code rather than PR count, you account for the variability in PR sizes and focus on the quality and impact of suggestions rather than just the number of PRs affected.
+3. **Quantifies Value and ROI:** The metric directly correlates with the value Qodo Merge is providing, showing how frequently it offers improvements relative to the amount of new code being written. This provides a clear, quantifiable way to demonstrate Qodo Merge's return on investment to stakeholders.
+
+#### Suggestion Effectiveness Across Categories
+
+![Impacted_Suggestion_Score](https://codium.ai/images/pr_agent/impact_by_category.png){width=512}
+> Explanation: This chart illustrates the distribution of implemented suggestions across different categories, enabling teams to better understand Qodo Merge's impact on various aspects of code quality and development practices.
+
+#### Suggestion Score Distribution
+
+![Impacted_Suggestion_Score](https://codium.ai/images/pr_agent/impacted_score_dist.png){width=512}
+> Explanation: The distribution of the suggestion score for the implemented suggestions, ensuring that higher-scored suggestions truly represent more significant improvements.

docs/docs/core-abilities/index.md

@@ -0,0 +1,35 @@
+# Core Abilities
+
+Qodo Merge utilizes a variety of core abilities to provide a comprehensive and efficient code review experience. These abilities include:
+
+- [Auto best practices](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/)
+- [Code validation](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/)
+- [Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/)
+- [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/)
+- [Fetching ticket context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/)
+- [Impact evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/)
+- [Interactivity](https://qodo-merge-docs.qodo.ai/core-abilities/interactivity/)
+- [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/)
+- [RAG context enrichment](https://qodo-merge-docs.qodo.ai/core-abilities/rag_context_enrichment/)
+- [Self-reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/)
+- [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/)
+
+## Blogs
+
+Here are some additional technical blogs from Qodo, that delve deeper into the core capabilities and features of Large Language Models (LLMs) when applied to coding tasks.
+These resources provide more comprehensive insights into leveraging LLMs for software development.
+
+### Code Generation and LLMs
+
+- [Effective AI code suggestions: less is more](https://www.qodo.ai/blog/effective-code-suggestions-llms-less-is-more/)
+- [State-of-the-art Code Generation with AlphaCodium – From Prompt Engineering to Flow Engineering](https://www.qodo.ai/blog/qodoflow-state-of-the-art-code-generation-for-code-contests/)
+- [RAG for a Codebase with 10k Repos](https://www.qodo.ai/blog/rag-for-large-scale-code-repos/)
+
+### Development Processes
+
+- [Understanding the Challenges and Pain Points of the Pull Request Cycle](https://www.qodo.ai/blog/understanding-the-challenges-and-pain-points-of-the-pull-request-cycle/)
+- [Introduction to Code Coverage Testing](https://www.qodo.ai/blog/introduction-to-code-coverage-testing/)
+
+### Cost Optimization
+
+- [Reduce Your Costs by 30% When Using GPT for Python Code](https://www.qodo.ai/blog/reduce-your-costs-by-30-when-using-gpt-3-for-python-code/)

docs/docs/core-abilities/interactivity.md

@@ -0,0 +1,41 @@
+# Interactivity
+
+`Supported Git Platforms: GitHub, GitLab`
+
+## Overview
+
+Qodo Merge transforms static code reviews into interactive experiences by enabling direct actions from pull request (PR) comments.
+Developers can immediately trigger actions and apply changes with simple checkbox clicks.
+
+This focused workflow maintains context while dramatically reducing the time between PR creation and final merge.
+The approach eliminates manual steps, provides clear visual indicators, and creates immediate feedback loops all within the same interface.
+
+## Key Interactive Features
+
+### 1\. Interactive `/improve` Tool
+
+The [`/improve`](https://qodo-merge-docs.qodo.ai/tools/improve/) command delivers a comprehensive interactive experience:
+
+- _**Apply this suggestion**_: Clicking this checkbox instantly converts a suggestion into a committable code change. When committed to the PR, changes made to code that was flagged for improvement will be marked with a check mark, allowing developers to easily track and review implemented recommendations.
+
+- _**More**_: Triggers additional suggestions generation while keeping each suggestion focused and relevant as the original set
+
+- _**Update**_: Triggers a re-analysis of the code, providing updated suggestions based on the latest changes
+
+- _**Author self-review**_: Interactive acknowledgment that developers have opened and reviewed collapsed suggestions
+
+### 2\. Interactive `/analyze` Tool
+
+The [`/analyze`](https://qodo-merge-docs.qodo.ai/tools/analyze/) command provides component-level analysis with interactive options for each identified code component:
+
+- Interactive checkboxes to generate tests, documentation, and code suggestions for specific components
+
+- On-demand similar code search that activates when a checkbox is clicked
+
+- Component-specific actions that trigger only for the selected elements, providing focused assistance
+
+### 3\. Interactive `/help` Tool
+
+The [`/help`](https://qodo-merge-docs.qodo.ai/tools/help/) command not only lists available tools and their descriptions but also enables immediate tool invocation through interactive checkboxes.
+When a user checks a tool's checkbox, Qodo Merge instantly triggers that tool without requiring additional commands.
+This transforms the standard help menu into an interactive launch pad for all Qodo Merge capabilities, eliminating context switching by keeping developers within their PR workflow.

docs/docs/core-abilities/metadata.md

@@ -0,0 +1,56 @@
+## Local and global metadata injection with multi-stage analysis
+
+1\.
+Qodo Merge initially retrieves for each PR the following data:
+
+- PR title and branch name
+- PR original description
+- Commit messages history
+- PR diff patches, in [hunk diff](https://loicpefferkorn.net/2014/02/diff-files-what-are-hunks-and-how-to-extract-them/) format
+- The entire content of the files that were modified in the PR
+
+!!! tip "Tip: Organization-level metadata"
+    In addition to the inputs above, Qodo Merge can incorporate supplementary preferences provided by the user, like [`extra_instructions` and `organization best practices`](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions-and-best-practices). This information can be used to enhance the PR analysis.
+
+2\.
+By default, the first command that Qodo Merge executes is [`describe`](https://qodo-merge-docs.qodo.ai/tools/describe/), which generates three types of outputs:
+
+- PR Type (e.g. bug fix, feature, refactor, etc)
+- PR Description - a bullet point summary of the PR
+- Changes walkthrough - for each modified file, provide a one-line summary followed by a detailed bullet point list of the changes.
+
+These AI-generated outputs are now considered as part of the PR metadata, and can be used in subsequent commands like `review` and `improve`.
+This effectively enables multi-stage chain-of-thought analysis, without doing any additional API calls which will cost time and money.
+
+For example, when generating code suggestions for different files, Qodo Merge can inject the AI-generated ["Changes walkthrough"](https://github.com/Codium-ai/pr-agent/pull/1202#issue-2511546839) file summary in the prompt:
+
+```diff
+## File: 'src/file1.py'
+### AI-generated file summary:
+- edited function `func1` that does X
+- Removed function `func2` that was not used
+- ....
+
+@@ ... @@ def func1():
+__new hunk__
+11  unchanged code line0
+12  unchanged code line1
+13 +new code line2 added
+14  unchanged code line3
+__old hunk__
+ unchanged code line0
+ unchanged code line1
+-old code line2 removed
+ unchanged code line3
+
+@@ ... @@ def func2():
+__new hunk__
+...
+__old hunk__
+...
+```
+
+3\. The entire PR files that were retrieved are also used to expand and enhance the PR context (see [Dynamic Context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/)).
+
+4\. All the metadata described above represents several level of cumulative analysis - ranging from hunk level, to file level, to PR level, to organization level.
+This comprehensive approach enables Qodo Merge AI models to generate more precise and contextually relevant suggestions and feedback.

docs/docs/core-abilities/rag_context_enrichment.md

@@ -0,0 +1,77 @@
+# RAG Context Enrichment 💎
+
+`Supported Git Platforms: GitHub, Bitbucket Data Center`
+
+!!! info "Prerequisites"
+    - RAG is available only for Qodo enterprise plan users, with single tenant or on-premises setup.
+    - Database setup and codebase indexing must be completed before proceeding. [Contact support](https://www.qodo.ai/contact/) for more information.
+
+## Overview
+
+### What is RAG Context Enrichment?
+
+A feature that enhances AI analysis by retrieving and referencing relevant code patterns from your project, enabling context-aware insights during code reviews.
+
+### How does RAG Context Enrichment work?
+
+Using Retrieval-Augmented Generation (RAG), it searches your configured repositories for contextually relevant code segments, enriching pull request (PR) insights and accelerating review accuracy.
+
+## Getting started
+
+### Configuration options
+
+In order to enable the RAG feature, add the following lines to your configuration file:
+
+```toml
+[rag_arguments]
+enable_rag=true
+```
+
+!!! example "RAG Arguments Options"
+
+    <table>
+      <tr>
+        <td><b>enable_rag</b></td>
+        <td>If set to true, repository enrichment using RAG will be enabled. Default is false.</td>
+      </tr>
+      <tr>
+        <td><b>rag_repo_list</b></td>
+        <td>A list of repositories that will be used by the semantic search for RAG. Use `['all']` to consider the entire codebase or a select list of repositories, for example: ['my-org/my-repo', ...]. Default: the repository from which the PR was opened.</td>
+      </tr>
+    </table>
+
+### Applications
+
+RAG capability is exclusively available in the following tools:
+
+=== "`/review`"
+    The [`/review`](https://qodo-merge-docs.qodo.ai/tools/review/) tool offers the _Focus area from RAG data_ which contains feedback based on the RAG references analysis.
+    The complete list of references found relevant to the PR will be shown in the _References_ section, helping developers understand the broader context by exploring the provided references.
+
+    ![RAGed review tool](https://codium.ai/images/pr_agent/rag_review.png){width=640}
+
+=== "`/implement`"
+    The [`/implement`](https://qodo-merge-docs.qodo.ai/tools/implement/) tool utilizes the RAG feature to provide comprehensive context of the repository codebase, allowing it to generate more refined code output.
+    The _References_ section contains links to the content used to support the code generation.
+
+    ![RAGed implement tool](https://codium.ai/images/pr_agent/rag_implement.png){width=640}
+
+=== "`/ask`"
+    The [`/ask`](https://qodo-merge-docs.qodo.ai/tools/ask/) tool can access broader repository context through the RAG feature when answering questions that go beyond the PR scope alone.
+    The _References_ section displays the additional repository content consulted to formulate the answer.
+
+    ![RAGed ask tool](https://codium.ai/images/pr_agent/rag_ask.png){width=640}
+
+## Limitations
+
+### Querying the codebase presents significant challenges
+
+- **Search Method**: RAG uses natural language queries to find semantically relevant code sections
+- **Result Quality**: No guarantee that RAG results will be useful for all queries
+- **Scope Recommendation**: To reduce noise, focus on the PR repository rather than searching across multiple repositories
+
+### This feature has several requirements and restrictions
+
+- **Codebase**: Must be properly indexed for search functionality
+- **Security**: Requires secure and private indexed codebase implementation
+- **Deployment**: Only available for Qodo Merge Enterprise plan using single tenant or on-premises setup

docs/docs/core-abilities/self_reflection.md

@@ -0,0 +1,49 @@
+## TL;DR
+
+Qodo Merge implements a **self-reflection** process where the AI model reflects, scores, and re-ranks its own suggestions, eliminating irrelevant or incorrect ones.
+This approach improves the quality and relevance of suggestions, saving users time and enhancing their experience.
+Configuration options allow users to set a score threshold for further filtering out suggestions.
+
+## Introduction - Efficient Review with Hierarchical Presentation
+
+Given that not all generated code suggestions will be relevant, it is crucial to enable users to review them in a fast and efficient way, allowing quick identification and filtering of non-applicable ones.
+
+To achieve this goal, Qodo Merge offers a dedicated hierarchical structure when presenting suggestions to users:
+
+- A "category" section groups suggestions by their category, allowing users to quickly dismiss irrelevant suggestions.
+- Each suggestion is first described by a one-line summary, which can be expanded to a full description by clicking on a collapsible.
+- Upon expanding a suggestion, the user receives a more comprehensive description, and a code snippet demonstrating the recommendation.
+
+!!! note "Fast Review"
+    This hierarchical structure is designed to facilitate rapid review of each suggestion, with users spending an average of ~5-10 seconds per item.
+
+## Self-reflection and Re-ranking
+
+The AI model is initially tasked with generating suggestions, and outputting them in order of importance.
+However, in practice we observe that models often struggle to simultaneously generate high-quality code suggestions and rank them well in a single pass.
+Furthermore, the initial set of generated suggestions sometimes contains easily identifiable errors.
+
+To address these issues, we implemented a "self-reflection" process that refines suggestion ranking and eliminates irrelevant or incorrect proposals.
+This process consists of the following steps:
+
+1. Presenting the generated suggestions to the model in a follow-up call.
+2. Instructing the model to score each suggestion on a scale of 0-10 and provide a rationale for the assigned score.
+3. Utilizing these scores to re-rank the suggestions and filter out incorrect ones (with a score of 0).
+4. Optionally, filtering out all suggestions below a user-defined score threshold.
+
+Note that presenting all generated suggestions simultaneously provides the model with a comprehensive context, enabling it to make more informed decisions compared to evaluating each suggestion individually.
+
+To conclude, the self-reflection process enables Qodo Merge to prioritize suggestions based on their importance, eliminate inaccurate or irrelevant proposals, and optionally exclude suggestions that fall below a specified threshold of significance.
+This results in a more refined and valuable set of suggestions for the user, saving time and improving the overall experience.
+
+## Example Results
+
+![self_reflection](https://codium.ai/images/pr_agent/self_reflection1.png){width=768}
+![self_reflection](https://codium.ai/images/pr_agent/self_reflection2.png){width=768}
+
+## Appendix - Relevant Configuration Options
+
+```toml
+[pr_code_suggestions]
+suggestions_score_threshold = 0 # Filter out suggestions with a score below this threshold (0-10)
+```

docs/docs/core-abilities/static_code_analysis.md

@@ -0,0 +1,74 @@
+## Overview - Static Code Analysis 💎
+
+By combining static code analysis with LLM capabilities, Qodo Merge can provide a comprehensive analysis of the PR code changes on a component level.
+
+It scans the PR code changes, finds all the code components (methods, functions, classes) that changed, and enables to interactively generate tests, docs, code suggestions and similar code search for each component.
+
+!!! note "Language that are currently supported:"
+    Python, Java, C++, JavaScript, TypeScript, C#.
+
+## Capabilities
+
+### Analyze PR
+
+The [`analyze`](https://qodo-merge-docs.qodo.ai/tools/analyze/) tool enables to interactively generate tests, docs, code suggestions and similar code search for each component that changed in the PR.
+It can be invoked manually by commenting on any PR:
+
+```
+/analyze
+```
+
+An example result:
+
+![Analyze 1](https://codium.ai/images/pr_agent/analyze_1.png){width=768}
+
+Clicking on each checkbox will trigger the relevant tool for the selected component.
+
+### Generate Tests
+
+The [`test`](https://qodo-merge-docs.qodo.ai/tools/test/) tool  generate tests for a selected component, based on the PR code changes.
+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,  Or be triggered interactively by using the `analyze` tool.
+
+![test1](https://codium.ai/images/pr_agent/test1.png){width=768}
+
+### Generate Docs for a Component
+
+The [`add_docs`](https://qodo-merge-docs.qodo.ai/tools/documentation/) tool scans the PR code changes, and automatically generate docstrings for any code components that changed in the PR.
+It can be invoked manually by commenting on any PR:
+
+```
+/add_docs component_name
+```
+
+Or be triggered interactively by using the `analyze` tool.
+
+![Docs single component](https://codium.ai/images/pr_agent/docs_single_component.png){width=768}
+
+### Generate Code Suggestions for a Component
+
+The [`improve_component`](https://qodo-merge-docs.qodo.ai/tools/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
+```
+
+Or be triggered interactively by using the `analyze` tool.
+
+![improve_component2](https://codium.ai/images/pr_agent/improve_component2.png){width=768}
+
+### Find Similar Code
+
+The [`similar code`](https://qodo-merge-docs.qodo.ai/tools/similar_code/) tool retrieves the most similar code components from inside the organization's codebase or from open-source code, including details about the license associated with each repository.
+
+For example:
+
+`Global Search` for a method called `chat_completion`:
+
+![similar code global](https://codium.ai/images/pr_agent/similar_code_global2.png){width=768}

docs/docs/css/custom.css

@@ -0,0 +1,49 @@
+
+
+:root {
+    --md-primary-fg-color: #765bfa;
+    --md-accent-fg-color: #AEA1F1;
+  }
+
+.md-nav--primary {
+    .md-nav__link {
+    font-size: 18px; /* Change the font size as per your preference */
+    }
+}
+
+.md-nav--primary {
+    position: relative; /* Ensure the element is positioned */
+}
+
+.md-nav--primary::before {
+    content: "";
+    position: absolute;
+    top: 0;
+    right: 10px; /* Move the border 10 pixels to the right */
+    width: 2px;
+    height: 100%;
+    background-color: #f5f5f5; /* Match the border color */
+}
+/*.md-nav__title, .md-nav__link  {*/
+/*    font-size: 18px;*/
+/*    margin-top: 14px; !* Adjust the space as needed *!*/
+/*    margin-bottom: 14px; !* Adjust the space as needed *!*/
+/*}*/
+
+.md-tabs__link  {
+    font-size: 18px;
+}
+
+.md-header__title {
+    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/faq/index.md

@@ -0,0 +1,90 @@
+# FAQ
+
+??? note "Q: Can Qodo Merge serve as a substitute for a human reviewer?"
+    #### Answer:<span style="display:none;">1</span>
+
+    Qodo Merge is designed to assist, not replace, human reviewers.
+
+    Reviewing PRs is a tedious and time-consuming task often seen as a "chore". In addition, the longer the PR – the shorter the relative feedback, since long PRs can overwhelm reviewers, both in terms of technical difficulty, and the actual review time.
+    Qodo Merge aims to address these pain points, and to assist and empower both the PR author and reviewer.
+
+    However, Qodo Merge has built-in safeguards to ensure the developer remains in the driver's seat. For example:
+
+    1. Preserves user's original PR header
+    2. Places user's description above the AI-generated PR description
+    3. Won't approve PRs; approval remains reviewer's responsibility
+    4. The code suggestions are optional, and aim to:
+        - Encourage self-review and self-reflection
+        - Highlight potential bugs or oversights
+        - Enhance code quality and promote best practices
+
+    Read more about this issue in our [blog](https://www.codium.ai/blog/understanding-the-challenges-and-pain-points-of-the-pull-request-cycle/)
+
+___
+
+??? note "Q: I received an incorrect or irrelevant suggestion. Why?"
+
+    #### Answer:<span style="display:none;">2</span>
+
+    - Modern AI models, like Claude Sonnet and GPT-4, are improving rapidly but remain imperfect. Users should critically evaluate all suggestions rather than accepting them automatically.
+    - AI errors are rare, but possible. A main value from reviewing the code suggestions lies in their high probability of catching **mistakes or bugs made by the PR author**. We believe it's worth spending 30-60 seconds reviewing suggestions, even if some aren't relevant, as this practice can enhance code quality and prevent bugs in production.
+
+
+    - The hierarchical structure of the suggestions is designed to help the user _quickly_ understand them, and to decide which ones are relevant and which are not:
+
+        - Only if the `Category` header is relevant, the user should move to the summarized suggestion description.
+        - Only if the summarized suggestion description is relevant, the user should click on the collapsible, to read the full suggestion description with a code preview example.
+
+    - In addition, we recommend to use the [`extra_instructions`](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions-and-best-practices) field to guide the model to suggestions that are more relevant to the specific needs of the project.
+    - The interactive [PR chat](https://qodo-merge-docs.qodo.ai/chrome-extension/) also provides an easy way to get more tailored suggestions and feedback from the AI model.
+
+___
+
+??? note "Q: How can I get more tailored suggestions?"
+    #### Answer:<span style="display:none;">3</span>
+
+    See [here](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions-and-best-practices) for more information on how to use the `extra_instructions` and `best_practices` configuration options, to guide the model to more tailored suggestions.
+
+___
+
+??? note "Q: Will you store my code? Are you using my code to train models?"
+    #### Answer:<span style="display:none;">4</span>
+
+    No. Qodo Merge strict privacy policy ensures that your code is not stored or used for training purposes.
+
+    For a detailed overview of our data privacy policy, please refer to [this link](https://qodo-merge-docs.qodo.ai/overview/data_privacy/)
+
+___
+
+??? note "Q: Can I use my own LLM keys with Qodo Merge?"
+    #### Answer:<span style="display:none;">5</span>
+
+    When you self-host the [open-source](https://github.com/Codium-ai/pr-agent) version, you use your own keys.
+
+    Qodo Merge with SaaS deployment is a hosted version of Qodo Merge, where Qodo manages the infrastructure and the keys.
+    For enterprise customers, on-prem deployment is also available. [Contact us](https://www.codium.ai/contact/#pricing) for more information.
+___
+
+??? note "Q: Can Qodo Merge review draft/offline PRs?"
+    #### Answer:<span style="display:none;">5</span>
+
+    Yes. While Qodo Merge won't automatically review draft PRs, you can still get feedback by manually requesting it through [online commenting](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#online-usage).
+
+    For active PRs, you can customize the automatic feedback settings [here](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#qodo-merge-automatic-feedback) to match your team's workflow.
+___
+
+??? note "Q: Can the 'Review effort' feedback be calibrated or customized?"
+    #### Answer:<span style="display:none;">5</span>
+
+    Yes, you can customize review effort estimates using the `extra_instructions` configuration option (see [documentation](https://qodo-merge-docs.qodo.ai/tools/review/#configuration-options)).
+    
+    Example mapping:
+
+    - Effort 1: < 30 minutes review time
+    - Effort 2: 30-60 minutes review time
+    - Effort 3: 60-90 minutes review time
+    - ...
+    
+    Note: The effort levels (1-5) are primarily meant for _comparative_ purposes, helping teams prioritize reviewing smaller PRs first. The actual review duration may vary, as the focus is on providing consistent relative effort estimates.
+
+___

docs/docs/index.md

@@ -0,0 +1,112 @@
+# Overview
+
+[PR-Agent](https://github.com/Codium-ai/pr-agent) is an open-source tool to help efficiently review and handle pull requests.
+Qodo Merge is a hosted version of PR-Agent, designed for companies and teams that require additional features and capabilities
+
+- See the [Installation Guide](./installation/index.md) for instructions on installing and running the tool on different git platforms.
+
+- See the [Usage Guide](./usage-guide/index.md) for instructions on running commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened.
+
+- See the [Tools Guide](./tools/index.md) for a detailed description of the different tools.
+
+- See the [Video Tutorials](https://www.youtube.com/playlist?list=PLRTpyDOSgbwFMA_VBeKMnPLaaZKwjGBFT) for practical demonstrations on how to use the tools.
+
+## Docs Smart Search
+
+To search the documentation site using natural language:
+
+1) Comment `/help "your question"` in either:
+
+   - A pull request where Qodo Merge is installed
+   - A [PR Chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat)
+
+2) The bot will respond with an [answer](https://github.com/Codium-ai/pr-agent/pull/1241#issuecomment-2365259334) that includes relevant documentation links.
+
+## Features
+
+PR-Agent and Qodo Merge offers extensive pull request functionalities across various git providers:
+
+|       |                                                                                                         | GitHub | GitLab | Bitbucket | Azure DevOps |
+| ----- | ------------------------------------------------------------------------------------------------------- |:------:|:------:|:---------:|:------------:|
+| TOOLS | [Review](https://qodo-merge-docs.qodo.ai/tools/review/)                                                 |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Describe](https://qodo-merge-docs.qodo.ai/tools/describe/)                                             |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Improve](https://qodo-merge-docs.qodo.ai/tools/improve/)                                               |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Ask](https://qodo-merge-docs.qodo.ai/tools/ask/)                                                       |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | ⮑ [Ask on code lines](https://qodo-merge-docs.qodo.ai/tools/ask/#ask-lines)                             |   ✅   |   ✅   |           |              |
+|       | [Update CHANGELOG](https://qodo-merge-docs.qodo.ai/tools/update_changelog/)                             |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Help Docs](https://qodo-merge-docs.qodo.ai/tools/help_docs/?h=auto#auto-approval)                      |   ✅   |   ✅   |    ✅     |              |
+|       | [Ticket Context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/) 💎            |   ✅   |   ✅   |    ✅     |              |
+|       | [Utilizing Best Practices](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) 💎            |   ✅   |   ✅   |    ✅     |              |
+|       | [PR Chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) 💎                        |   ✅   |        |           |              |
+|       | [Suggestion Tracking](https://qodo-merge-docs.qodo.ai/tools/improve/#suggestion-tracking) 💎            |   ✅   |   ✅   |           |              |
+|       | [CI Feedback](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/) 💎                                    |   ✅   |        |           |              |
+|       | [PR Documentation](https://qodo-merge-docs.qodo.ai/tools/documentation/) 💎                             |   ✅   |   ✅   |           |              |
+|       | [Custom Labels](https://qodo-merge-docs.qodo.ai/tools/custom_labels/) 💎                                |   ✅   |   ✅   |           |              |
+|       | [Analyze](https://qodo-merge-docs.qodo.ai/tools/analyze/) 💎                                            |   ✅   |   ✅   |           |              |
+|       | [Similar Code](https://qodo-merge-docs.qodo.ai/tools/similar_code/) 💎                                  |   ✅   |        |           |              |
+|       | [Custom Prompt](https://qodo-merge-docs.qodo.ai/tools/custom_prompt/) 💎                                |   ✅   |   ✅   |    ✅     |              |
+|       | [Test](https://qodo-merge-docs.qodo.ai/tools/test/) 💎                                                  |   ✅   |   ✅   |           |              |
+|       | [Implement](https://qodo-merge-docs.qodo.ai/tools/implement/) 💎                                        |   ✅   |   ✅   |    ✅     |              |
+|       | [Scan Repo Discussions](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/) 💎                |   ✅   |        |           |              |
+|       | [Repo Statistics](https://qodo-merge-docs.qodo.ai/tools/repo_statistics/) 💎                            |   ✅   |        |           |              |
+|       | [Auto-Approve](https://qodo-merge-docs.qodo.ai/tools/improve/?h=auto#auto-approval) 💎                  |   ✅   |   ✅   |    ✅     |              |
+|       |                                                                                                         |        |        |           |              |
+| USAGE | [CLI](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#local-repo-cli)                |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [App / webhook](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#github-app)          |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Tagging bot](https://github.com/Codium-ai/pr-agent#try-it-now)                                         |   ✅   |        |           |              |
+|       | [Actions](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action)                  |   ✅   |   ✅   |    ✅     |      ✅      |
+|       |                                                                                                         |        |        |           |              |
+| CORE  | [PR compression](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/)                  |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | Adaptive and token-aware file patch fitting                                                             |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Multiple models support](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/)                |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/)                   |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/)                      |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Self reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/)                      |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/) 💎         |   ✅   |   ✅   |           |              |
+|       | [Global and wiki configurations](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) 💎 |   ✅   |   ✅   |    ✅     |              |
+|       | [PR interactive actions](https://www.qodo.ai/images/pr_agent/pr-actions.mp4) 💎                         |   ✅   |   ✅   |           |              |
+|       | [Impact Evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) 💎               |   ✅   |   ✅   |           |              | 
+|       | [Code Validation 💎](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/)                   |   ✅   |   ✅   |    ✅     |      ✅      |
+|       | [Auto Best Practices 💎](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/)                     |   ✅   |      |         |            |
+!!! note "💎 means Qodo Merge only"
+      All along the documentation, 💎 marks a feature available only in [Qodo Merge](https://www.codium.ai/pricing/){:target="_blank"}, and not in the open-source version.
+
+## Example Results
+
+<hr>
+
+#### [/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>
+
+#### [/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>
+
+#### [/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
+
+The following diagram illustrates Qodo Merge tools and their flow:
+
+![Qodo Merge Tools](https://codium.ai/images/pr_agent/diagram-v0.9.png)
+
+Check out the [PR Compression strategy](core-abilities/index.md) page for more details on how we convert a code diff to a manageable LLM prompt

docs/docs/installation/azure.md

@@ -0,0 +1,101 @@
+## Azure DevOps Pipeline
+
+You can use a pre-built Action Docker image to run PR-Agent as an Azure devops pipeline.
+add the following file to your repository under `azure-pipelines.yml`:
+
+```yaml
+# Opt out of CI triggers
+trigger: none
+
+# Configure PR trigger
+pr:
+  branches:
+    include:
+    - '*'
+  autoCancel: true
+  drafts: false
+
+stages:
+- stage: pr_agent
+  displayName: 'PR Agent Stage'
+  jobs:
+  - job: pr_agent_job
+    displayName: 'PR Agent Job'
+    pool:
+      vmImage: 'ubuntu-latest'
+    container:
+      image: codiumai/pr-agent:latest
+      options: --entrypoint ""
+    variables:
+      - group: pr_agent
+    steps:
+    - script: |
+        echo "Running PR Agent action step"
+
+        # Construct PR_URL
+        PR_URL="${SYSTEM_COLLECTIONURI}${SYSTEM_TEAMPROJECT}/_git/${BUILD_REPOSITORY_NAME}/pullrequest/${SYSTEM_PULLREQUEST_PULLREQUESTID}"
+        echo "PR_URL=$PR_URL"
+
+        # Extract organization URL from System.CollectionUri
+        ORG_URL=$(echo "$(System.CollectionUri)" | sed 's/\/$//') # Remove trailing slash if present
+        echo "Organization URL: $ORG_URL"
+
+        export azure_devops__org="$ORG_URL"
+        export config__git_provider="azure"
+
+        pr-agent --pr_url="$PR_URL" describe
+        pr-agent --pr_url="$PR_URL" review
+        pr-agent --pr_url="$PR_URL" improve
+      env:
+        azure_devops__pat: $(azure_devops_pat)
+        openai__key: $(OPENAI_KEY)
+      displayName: 'Run Qodo Merge'
+```
+
+This script will run Qodo Merge on every new merge request, with the `improve`, `review`, and `describe` commands.
+Note that you need to export the `azure_devops__pat` and `OPENAI_KEY` variables in the Azure DevOps pipeline settings (Pipelines -> Library -> + Variable group):
+
+![Qodo Merge](https://codium.ai/images/pr_agent/azure_devops_pipeline_secrets.png){width=468}
+
+Make sure to give pipeline permissions to the `pr_agent` variable group.
+
+> Note that Azure Pipelines lacks support for triggering workflows from PR comments. If you find a viable solution, please contribute it to our [issue tracker](https://github.com/Codium-ai/pr-agent/issues)
+
+## Azure DevOps from CLI
+
+To use Azure DevOps provider use the following settings in configuration.toml:
+
+```toml
+[config]
+git_provider="azure"
+```
+
+Azure DevOps provider supports [PAT token](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=Windows) or [DefaultAzureCredential](https://learn.microsoft.com/en-us/azure/developer/python/sdk/authentication-overview#authentication-in-server-environments) authentication.
+PAT is faster to create, but has build in expiration date, and will use the user identity for API calls.
+Using DefaultAzureCredential you can use managed identity or Service principle, which are more secure and will create separate ADO user identity (via AAD) to the agent.
+
+If PAT was chosen, you can assign the value in .secrets.toml.
+If DefaultAzureCredential was chosen, you can assigned the additional env vars like AZURE_CLIENT_SECRET directly,
+or use managed identity/az cli (for local development) without any additional configuration.
+in any case, 'org' value must be assigned in .secrets.toml:
+
+```toml
+[azure_devops]
+org = "https://dev.azure.com/YOUR_ORGANIZATION/"
+# pat = "YOUR_PAT_TOKEN" needed only if using PAT for authentication
+```
+
+## Azure DevOps Webhook
+
+To trigger from an Azure webhook, you need to manually [add a webhook](https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops).
+Use the "Pull request created" type to trigger a review, or "Pull request commented on" to trigger any supported comment with /<command> <args> comment on the relevant PR. Note that for the "Pull request commented on" trigger, only API v2.0 is supported.
+
+For webhook security, create a sporadic username/password pair and configure the webhook username and password on both the server and Azure DevOps webhook. These will be sent as basic Auth data by the webhook with each request:
+
+```toml
+[azure_devops_server]
+webhook_username = "<basic auth user>"
+webhook_password = "<basic auth password>"
+```
+
+> :warning: **Ensure that the webhook endpoint is only accessible over HTTPS** to mitigate the risk of credential interception when using basic authentication.

docs/docs/installation/bitbucket.md

@@ -0,0 +1,68 @@
+## Run as a Bitbucket Pipeline
+
+You can use the Bitbucket Pipeline system to run PR-Agent on every pull request open or update.
+
+1. Add the following file in your repository bitbucket-pipelines.yml
+
+```yaml
+pipelines:
+    pull-requests:
+      '**':
+        - step:
+            name: PR Agent Review
+            image: codiumai/pr-agent:latest
+            script:
+              - pr-agent --pr_url=https://bitbucket.org/$BITBUCKET_WORKSPACE/$BITBUCKET_REPO_SLUG/pull-requests/$BITBUCKET_PR_ID review
+```
+
+2. Add the following secure variables to your repository under Repository settings > Pipelines > Repository variables.
+
+   - CONFIG__GIT_PROVIDER: `bitbucket`
+   - OPENAI__KEY: `<your key>`
+   - BITBUCKET__AUTH_TYPE: `basic` or `bearer` (default is `bearer`)
+   - BITBUCKET__BEARER_TOKEN: `<your token>` (required when auth_type is bearer)
+   - BITBUCKET__BASIC_TOKEN: `<your token>` (required when auth_type is basic)
+
+You can get a Bitbucket token for your repository by following Repository Settings -> Security -> Access Tokens.
+For basic auth, you can generate a base64 encoded token from your username:password combination.
+
+Note that comments on a PR are not supported in Bitbucket Pipeline.
+
+## Bitbucket Server and Data Center
+
+Login into your on-prem instance of Bitbucket with your service account username and password.
+Navigate to `Manage account`, `HTTP Access tokens`, `Create Token`.
+Generate the token and add it to .secret.toml under `bitbucket_server` section
+
+```toml
+[bitbucket_server]
+bearer_token = "<your key>"
+```
+
+### Run it as CLI
+
+Modify `configuration.toml`:
+
+```toml
+git_provider="bitbucket_server"
+```
+
+and pass the Pull request URL:
+
+```shell
+python cli.py --pr_url https://git.onpreminstanceofbitbucket.com/projects/PROJECT/repos/REPO/pull-requests/1 review
+```
+
+### Run it as service
+
+To run PR-Agent as webhook, build the docker image:
+
+```bash
+docker build . -t codiumai/pr-agent:bitbucket_server_webhook --target bitbucket_server_webhook -f docker/Dockerfile
+docker push codiumai/pr-agent:bitbucket_server_webhook  # Push to your Docker repository
+```
+
+Navigate to `Projects` or `Repositories`, `Settings`, `Webhooks`, `Create Webhook`.
+Fill the name and URL, Authentication None select the Pull Request Opened checkbox to receive that event as webhook.
+
+The URL should end with `/webhook`, for example: https://domain.com/webhook

docs/docs/installation/github.md

@@ -0,0 +1,277 @@
+## Run as a GitHub Action
+
+You can use our pre-built Github Action Docker image to run PR-Agent as a Github Action.
+
+1) Add the following file to your repository under `.github/workflows/pr_agent.yml`:
+
+```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
+      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: qodo-ai/pr-agent@main
+        env:
+          OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+2) Add the following secret to your repository under `Settings > Secrets and variables > Actions > New repository secret > Add secret`:
+
+```
+Name = OPENAI_KEY
+Secret = <your key>
+```
+
+The GITHUB_TOKEN secret is automatically created by GitHub.
+
+3) Merge this change to your main branch.
+When you open your next PR, you should see a comment from `github-actions` bot with a review of your PR, and instructions on how to use the rest of the tools.
+
+4) You may configure Qodo Merge by adding environment variables under the env section corresponding to any configurable property in the [configuration](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) file. Some examples:
+
+```yaml
+      env:
+        # ... previous environment values
+        OPENAI.ORG: "<Your organization name under your OpenAI account>"
+        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://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#github-action)
+
+### Using a specific release
+
+!!! tip ""
+    if you want to pin your action to a specific release (v0.23 for example) for stability reasons, use:
+    ```yaml
+    ...
+        steps:
+          - name: PR Agent action step
+            id: pragent
+            uses: docker://codiumai/pr-agent:0.23-github_action
+    ...
+    ```
+
+    For enhanced security, you can also specify the Docker image by its [digest](https://hub.docker.com/repository/docker/codiumai/pr-agent/tags):
+    ```yaml
+    ...
+        steps:
+          - name: PR Agent action step
+            id: pragent
+            uses: docker://codiumai/pr-agent@sha256:14165e525678ace7d9b51cda8652c2d74abb4e1d76b57c4a6ccaeba84663cc64
+    ...
+    ```
+
+### Action for GitHub enterprise server
+
+!!! tip ""
+    To use the action with a GitHub enterprise server, add an environment variable `GITHUB.BASE_URL` with the API URL of your GitHub server.
+
+    For example, if your GitHub server is at `https://github.mycompany.com`, add the following to your workflow file:
+    ```yaml
+          env:
+            # ... previous environment values
+            GITHUB.BASE_URL: "https://github.mycompany.com/api/v3"
+    ```
+
+---
+
+## Run as a GitHub App
+
+Allowing you to automate the review process on your private or public repositories.
+
+1) Create a GitHub App from the [Github Developer Portal](https://docs.github.com/en/developers/apps/creating-a-github-app).
+
+   - Set the following permissions:
+     - Pull requests: Read & write
+     - Issue comment: Read & write
+     - Metadata: Read-only
+     - Contents: Read-only
+   - Set the following events:
+     - Issue comment
+     - Pull request
+     - Push (if you need to enable triggering on PR update)
+
+2) Generate a random secret for your app, and save it for later. For example, you can use:
+
+```bash
+WEBHOOK_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))")
+```
+
+3) Acquire the following pieces of information from your app's settings page:
+
+   - App private key (click "Generate a private key" and save the file)
+   - App ID
+
+4) Clone this repository:
+
+```bash
+git clone https://github.com/Codium-ai/pr-agent.git
+```
+
+5) Copy the secrets template file and fill in the following:
+
+```bash
+cp pr_agent/settings/.secrets_template.toml pr_agent/settings/.secrets.toml
+# Edit .secrets.toml file
+```
+
+- Your OpenAI key.
+- Copy your app's private key to the private_key field.
+- Copy your app's ID to the app_id field.
+- Copy your app's webhook secret to the webhook_secret field.
+- Set deployment_type to 'app' in [configuration.toml](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml)
+
+    > The .secrets.toml file is not copied to the Docker image by default, and is only used for local development.
+    > If you want to use the .secrets.toml file in your Docker image, you can add remove it from the .dockerignore file.
+    > In most production environments, you would inject the secrets file as environment variables or as mounted volumes.
+    > For example, in order to inject a secrets file as a volume in a Kubernetes environment you can update your pod spec to include the following,
+    > assuming you have a secret named `pr-agent-settings` with a key named `.secrets.toml`:
+
+    ```
+           volumes:
+            - name: settings-volume
+              secret:
+                secretName: pr-agent-settings
+    // ...
+           containers:
+    // ...
+              volumeMounts:
+                - mountPath: /app/pr_agent/settings_prod
+                  name: settings-volume
+    ```
+
+    > Another option is to set the secrets as environment variables in your deployment environment, for example `OPENAI.KEY` and `GITHUB.USER_TOKEN`.
+
+6) Build a Docker image for the app and optionally push it to a Docker repository. We'll use Dockerhub as an example:
+
+    ```bash
+    docker build . -t codiumai/pr-agent:github_app --target github_app -f docker/Dockerfile
+    docker push codiumai/pr-agent:github_app  # Push to your Docker repository
+    ```
+
+7. Host the app using a server, serverless function, or container environment. Alternatively, for development and
+   debugging, you may use tools like smee.io to forward webhooks to your local machine.
+    You can check [Deploy as a Lambda Function](#deploy-as-a-lambda-function)
+
+8. Go back to your app's settings, and set the following:
+
+   - Webhook URL: The URL of your app's server or the URL of the smee.io channel.
+   - Webhook secret: The secret you generated earlier.
+
+9. Install the app by navigating to the "Install App" tab and selecting your desired repositories.
+
+> **Note:** When running Qodo Merge from GitHub app, the default configuration file (configuration.toml) will be loaded.
+> However, you can override the default tool parameters by uploading a local configuration file `.pr_agent.toml`
+> For more information please check out the [USAGE GUIDE](../usage-guide/automations_and_usage.md#github-app)
+---
+
+## 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
+    docker buildx build --platform=linux/amd64 . -t codiumai/pr-agent:serverless -f docker/Dockerfile.lambda
+   ```
+
+3. Push image to ECR
+
+    ```shell
+
+ docker tag codiumai/pr-agent:serverless <AWS_ACCOUNT>.dkr.ecr.<AWS_REGION>.amazonaws.com/codiumai/pr-agent:serverless
+ docker push <AWS_ACCOUNT>.dkr.ecr.<AWS_REGION>.amazonaws.com/codiumai/pr-agent:serverless
+    ```
+
+4. Create a lambda function that uses the uploaded image. Set the lambda timeout to be at least 3m.
+5. Configure the lambda function to have a Function URL.
+6. In the environment variables of the Lambda function, specify `AZURE_DEVOPS_CACHE_DIR` to a writable location such as /tmp. (see [link](https://github.com/Codium-ai/pr-agent/pull/450#issuecomment-1840242269))
+7. Go back to steps 8-9 of [Method 5](#run-as-a-github-app) with the function url as your Webhook URL.
+    The Webhook URL would look like `https://<LAMBDA_FUNCTION_URL>/api/v1/github_webhooks`
+
+---
+
+## AWS CodeCommit Setup
+
+Not all features have been added to CodeCommit yet.  As of right now, CodeCommit has been implemented to run the Qodo Merge CLI on the command line, using AWS credentials stored in environment variables.  (More features will be added in the future.)  The following is a set of instructions to have Qodo Merge do a review of your CodeCommit pull request from the command line:
+
+1. Create an IAM user that you will use to read CodeCommit pull requests and post comments
+    - Note: That user should have CLI access only, not Console access
+2. Add IAM permissions to that user, to allow access to CodeCommit (see IAM Role example below)
+3. Generate an Access Key for your IAM user
+4. Set the Access Key and Secret using environment variables (see Access Key example below)
+5. Set the `git_provider` value to `codecommit` in the `pr_agent/settings/configuration.toml` settings file
+6. Set the `PYTHONPATH` to include your `pr-agent` project directory
+    - Option A: Add `PYTHONPATH="/PATH/TO/PROJECTS/pr-agent` to your `.env` file
+    - Option B: Set `PYTHONPATH` and run the CLI in one command, for example:
+        - `PYTHONPATH="/PATH/TO/PROJECTS/pr-agent python pr_agent/cli.py [--ARGS]`
+
+---
+
+#### AWS CodeCommit IAM Role Example
+
+Example IAM permissions to that user to allow access to CodeCommit:
+
+- Note: The following is a working example of IAM permissions that has read access to the repositories and write access to allow posting comments
+- Note: If you only want pr-agent to review your pull requests, you can tighten the IAM permissions further, however this IAM example will work, and allow the pr-agent to post comments to the PR
+- Note: You may want to replace the `"Resource": "*"` with your list of repos, to limit access to only those repos
+
+```json
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Effect": "Allow",
+            "Action": [
+                "codecommit:BatchDescribe*",
+                "codecommit:BatchGet*",
+                "codecommit:Describe*",
+                "codecommit:EvaluatePullRequestApprovalRules",
+                "codecommit:Get*",
+                "codecommit:List*",
+                "codecommit:PostComment*",
+                "codecommit:PutCommentReaction",
+                "codecommit:UpdatePullRequestDescription",
+                "codecommit:UpdatePullRequestTitle"
+            ],
+            "Resource": "*"
+        }
+    ]
+}
+```
+
+#### AWS CodeCommit Access Key and Secret
+
+Example setting the Access Key and Secret using environment variables
+
+```sh
+export AWS_ACCESS_KEY_ID="XXXXXXXXXXXXXXXX"
+export AWS_SECRET_ACCESS_KEY="XXXXXXXXXXXXXXXX"
+export AWS_DEFAULT_REGION="us-east-1"
+```
+
+#### AWS CodeCommit CLI Example
+
+After you set up AWS CodeCommit using the instructions above, here is an example CLI run that tells pr-agent to **review** a given pull request.
+(Replace your specific PYTHONPATH and PR URL in the example)
+
+```sh
+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/gitlab.md

@@ -0,0 +1,90 @@
+## Run as a GitLab Pipeline
+
+You can use a pre-built Action Docker image to run PR-Agent as a GitLab pipeline. This is a simple way to get started with Qodo Merge without setting up your own server.
+
+(1) Add the following file to your repository under `.gitlab-ci.yml`:
+
+```yaml
+stages:
+  - pr_agent
+
+pr_agent_job:
+  stage: pr_agent
+  image:
+    name: codiumai/pr-agent:latest
+    entrypoint: [""]
+  script:
+    - cd /app
+    - echo "Running PR Agent action step"
+    - export MR_URL="$CI_MERGE_REQUEST_PROJECT_URL/merge_requests/$CI_MERGE_REQUEST_IID"
+    - echo "MR_URL=$MR_URL"
+    - export gitlab__url=$CI_SERVER_PROTOCOL://$CI_SERVER_FQDN
+    - export gitlab__PERSONAL_ACCESS_TOKEN=$GITLAB_PERSONAL_ACCESS_TOKEN
+    - export config__git_provider="gitlab"
+    - export openai__key=$OPENAI_KEY
+    - python -m pr_agent.cli --pr_url="$MR_URL" describe
+    - python -m pr_agent.cli --pr_url="$MR_URL" review
+    - python -m pr_agent.cli --pr_url="$MR_URL" improve
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
+```
+
+This script will run Qodo Merge on every new merge request. You can modify the `rules` section to run Qodo Merge on different events.
+You can also modify the `script` section to run different Qodo Merge commands, or with different parameters by exporting different environment variables.
+
+(2) Add the following masked variables to your GitLab repository (CI/CD -> Variables):
+
+- `GITLAB_PERSONAL_ACCESS_TOKEN`: Your GitLab personal access token.
+
+- `OPENAI_KEY`: Your OpenAI key.
+
+Note that if your base branches are not protected, don't set the variables as `protected`, since the pipeline will not have access to them.
+
+> **Note**: The `$CI_SERVER_FQDN` variable is available starting from GitLab version 16.10. If you're using an earlier version, this variable will not be available. However, you can combine `$CI_SERVER_HOST` and `$CI_SERVER_PORT` to achieve the same result. Please ensure you're using a compatible version or adjust your configuration.
+
+## Run a GitLab webhook server
+
+1. In GitLab create a new user and give it "Reporter" role ("Developer" if using Pro version of the agent) for the intended group or project.
+
+2. For the user from step 1. generate a `personal_access_token` with `api` access.
+
+3. Generate a random secret for your app, and save it for later (`shared_secret`). For example, you can use:
+
+```bash
+SHARED_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))")
+```
+
+4. Clone this repository:
+
+```bash
+git clone https://github.com/qodo-ai/pr-agent.git
+```
+
+5. Prepare variables and secrets. Skip this step if you plan on setting these as environment variables when running the agent:
+1. In the configuration file/variables:
+    - Set `config.git_provider` to "gitlab"
+
+2. In the secrets file/variables:
+    - Set your AI model key in the respective section
+    - In the [gitlab] section, set `personal_access_token` (with token from step 2) and `shared_secret` (with secret from step 3)
+
+6. Build a Docker image for the app and optionally push it to a Docker repository. We'll use Dockerhub as an example:
+
+```bash
+docker build . -t gitlab_pr_agent --target gitlab_webhook -f docker/Dockerfile
+docker push codiumai/pr-agent:gitlab_webhook  # Push to your Docker repository
+```
+
+7. Set the environmental variables, the method depends on your docker runtime. Skip this step if you included your secrets/configuration directly in the Docker image.
+
+```bash
+CONFIG__GIT_PROVIDER=gitlab
+GITLAB__PERSONAL_ACCESS_TOKEN=<personal_access_token>
+GITLAB__SHARED_SECRET=<shared_secret>
+GITLAB__URL=https://gitlab.com
+OPENAI__KEY=<your_openai_api_key>
+```
+
+8. Create a webhook in your GitLab project. Set the URL to `http[s]://<PR_AGENT_HOSTNAME>/webhook`, the secret token to the generated secret from step 3, and enable the triggers `push`, `comments` and `merge request events`.
+
+9. Test your installation by opening a merge request or commenting on a merge request using one of PR Agent's commands.

docs/docs/installation/index.md

@@ -0,0 +1,18 @@
+# Installation
+
+## Self-hosted PR-Agent
+
+There are several ways to use self-hosted PR-Agent:
+
+- [Locally](./locally.md)
+- [GitHub integration](./github.md)
+- [GitLab integration](./gitlab.md)
+- [BitBucket integration](./bitbucket.md)
+- [Azure DevOps integration](./azure.md)
+
+## Qodo Merge 💎
+
+Qodo Merge, an app hosted by QodoAI for GitHub\GitLab\BitBucket, is also available.
+<br>
+With Qodo Merge, installation is as simple as adding the Qodo Merge app to your relevant repositories.
+See [here](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/) for more details.

docs/docs/installation/locally.md

@@ -0,0 +1,158 @@
+To run PR-Agent locally, you first need to acquire two keys:
+
+1. An OpenAI key from [here](https://platform.openai.com/api-keys){:target="_blank"}, with access to GPT-4 and o4-mini (or a key for other [language models](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/), if you prefer).
+2. A personal access token from your Git platform (GitHub, GitLab, BitBucket) with repo scope. GitHub token, for example, can be issued from [here](https://github.com/settings/tokens){:target="_blank"}
+
+## Using Docker image
+
+A list of the relevant tools can be found in the [tools guide](../tools/).
+
+To invoke a tool (for example `review`), you can run PR-Agent directly from the Docker image. Here's how:
+
+- For GitHub:
+
+    ```bash
+    docker run --rm -it -e OPENAI.KEY=<your key> -e GITHUB.USER_TOKEN=<your token> codiumai/pr-agent:latest --pr_url <pr_url> review
+    ```
+
+    If you are using GitHub enterprise server, you need to specify the custom url as variable.
+    For example, if your GitHub server is at `https://github.mycompany.com`, add the following to the command:
+
+    ```bash
+    -e GITHUB.BASE_URL=https://github.mycompany.com/api/v3
+    ```
+
+- For GitLab:
+
+    ```bash
+    docker run --rm -it -e OPENAI.KEY=<your key> -e CONFIG.GIT_PROVIDER=gitlab -e GITLAB.PERSONAL_ACCESS_TOKEN=<your token> codiumai/pr-agent:latest --pr_url <pr_url> review
+    ```
+
+    If you have a dedicated GitLab instance, you need to specify the custom url as variable:
+
+    ```bash
+    -e GITLAB.URL=<your gitlab instance url>
+    ```
+
+- For BitBucket:
+
+    ```bash
+    docker run --rm -it -e CONFIG.GIT_PROVIDER=bitbucket -e OPENAI.KEY=$OPENAI_API_KEY -e BITBUCKET.BEARER_TOKEN=$BITBUCKET_BEARER_TOKEN codiumai/pr-agent:latest --pr_url=<pr_url> review
+    ```
+
+For other git providers, update `CONFIG.GIT_PROVIDER` accordingly and check the [`pr_agent/settings/.secrets_template.toml`](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/.secrets_template.toml) file for environment variables expected names and values.
+
+### Utilizing environment variables
+
+It is also possible to provide or override the configuration by setting the corresponding environment variables.
+You can define the corresponding environment variables by following this convention: `<TABLE>__<KEY>=<VALUE>` or `<TABLE>.<KEY>=<VALUE>`.
+The `<TABLE>` refers to a table/section in a configuration file and `<KEY>=<VALUE>` refers to the key/value pair of a setting in the configuration file.
+
+For example, suppose you want to run `pr_agent` that connects to a self-hosted GitLab instance similar to an example above.
+You can define the environment variables in a plain text file named `.env` with the following content:
+
+```bash
+CONFIG__GIT_PROVIDER="gitlab"
+GITLAB__URL="<your url>"
+GITLAB__PERSONAL_ACCESS_TOKEN="<your token>"
+OPENAI__KEY="<your key>"
+```
+
+Then, you can run `pr_agent` using Docker with the following command:
+
+```shell
+docker run --rm -it --env-file .env codiumai/pr-agent:latest <tool> <tool parameter>
+```
+
+---
+
+### I get an error when running the Docker image. What should I do?
+
+If you encounter an error when running the Docker image, it is almost always due to a misconfiguration of api keys or tokens.
+
+Note that litellm, which is used by pr-agent, sometimes returns non-informative error messages such as `APIError: OpenAIException - Connection error.`
+Carefully check the api keys and tokens you provided and make sure they are correct.
+Adjustments may be needed depending on your llm provider.
+
+For example, for Azure OpenAI, additional keys are [needed](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/#azure).
+Same goes for other providers, make sure to check the [documentation](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/#changing-a-model)
+
+## Using pip package
+
+Install the package:
+
+```bash
+pip install pr-agent
+```
+
+Then run the relevant tool with the script below.
+<br>
+Make sure to fill in the required parameters (`user_token`, `openai_key`, `pr_url`, `command`):
+
+```python
+from pr_agent import cli
+from pr_agent.config_loader import get_settings
+
+def main():
+    # Fill in the following values
+    provider = "github" # github/gitlab/bitbucket/azure_devops
+    user_token = "..."  #  user token
+    openai_key = "..."  # OpenAI key
+    pr_url = "..."      # PR URL, for example 'https://github.com/Codium-ai/pr-agent/pull/809'
+    command = "/review" # Command to run (e.g. '/review', '/describe', '/ask="What is the purpose of this PR?"', ...)
+
+    # Setting the configurations
+    get_settings().set("CONFIG.git_provider", provider)
+    get_settings().set("openai.key", openai_key)
+    get_settings().set("github.user_token", user_token)
+
+    # Run the command. Feedback will appear in GitHub PR comments
+    cli.run_command(pr_url, command)
+
+
+if __name__ == '__main__':
+    main()
+```
+
+## Run from source
+
+1. Clone this repository:
+
+```bash
+git clone https://github.com/Codium-ai/pr-agent.git
+```
+
+2. Navigate to the `/pr-agent` folder and install the requirements in your favorite virtual environment:
+
+```bash
+pip install -e .
+```
+
+*Note: If you get an error related to Rust in the dependency installation then make sure Rust is installed and in your `PATH`, instructions: https://rustup.rs*
+
+3. Copy the secrets template file and fill in your OpenAI key and your GitHub user token:
+
+```bash
+cp pr_agent/settings/.secrets_template.toml pr_agent/settings/.secrets.toml
+chmod 600 pr_agent/settings/.secrets.toml
+# Edit .secrets.toml file
+```
+
+4. Run the cli.py script:
+
+```bash
+python3 -m pr_agent.cli --pr_url <pr_url> review
+python3 -m pr_agent.cli --pr_url <pr_url> ask <your question>
+python3 -m pr_agent.cli --pr_url <pr_url> describe
+python3 -m pr_agent.cli --pr_url <pr_url> improve
+python3 -m pr_agent.cli --pr_url <pr_url> add_docs
+python3 -m pr_agent.cli --pr_url <pr_url> generate_labels
+python3 -m pr_agent.cli --issue_url <issue_url> similar_issue
+...
+```
+
+[Optional] Add the pr_agent folder to your PYTHONPATH
+
+```bash
+export PYTHONPATH=$PYTHONPATH:<PATH to pr_agent folder>
+```

docs/docs/installation/pr_agent.md

@@ -0,0 +1,49 @@
+# PR-Agent Installation Guide
+
+PR-Agent can be deployed in various environments and platforms. Choose the installation method that best suits your needs:
+
+## 🖥️ Local Installation
+
+Learn how to run PR-Agent locally using:
+
+- Docker image
+- pip package
+- CLI from source code
+
+[View Local Installation Guide →](https://qodo-merge-docs.qodo.ai/installation/locally/)
+
+## 🐙 GitHub Integration
+
+Set up PR-Agent with GitHub as:
+
+- GitHub Action
+- Local GitHub App
+
+[View GitHub Integration Guide →](https://qodo-merge-docs.qodo.ai/installation/github/)
+
+## 🦊 GitLab Integration
+
+Deploy PR-Agent on GitLab as:
+
+- GitLab pipeline job
+- Local GitLab webhook server
+
+[View GitLab Integration Guide →](https://qodo-merge-docs.qodo.ai/installation/gitlab/)
+
+## 🟦 BitBucket Integration
+
+Implement PR-Agent in BitBucket as:
+
+- BitBucket pipeline job
+- Local BitBucket server
+
+[View BitBucket Integration Guide →](https://qodo-merge-docs.qodo.ai/installation/bitbucket/)
+
+## 🔷  Azure DevOps Integration
+
+Configure PR-Agent with Azure DevOps as:
+
+- Azure DevOps pipeline job
+- Local Azure DevOps webhook
+
+[View Azure DevOps Integration Guide →](https://qodo-merge-docs.qodo.ai/installation/azure/)

docs/docs/installation/qodo_merge.md

@@ -0,0 +1,98 @@
+Qodo Merge is a versatile application compatible with GitHub, GitLab, and BitBucket, hosted by QodoAI.
+See [here](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) for more details about the benefits of using Qodo Merge.
+
+## Trial Period and Licensing
+
+### Cloud Users with Teams Account
+
+A complimentary two-week trial is provided to all new users (with three additional grace usages). When the trial period ends, users will stop receiving feedback from Qodo Merge.
+
+Following the trial period, user licenses (seats) are required for continued access. Each user requires an individual seat license.
+After purchasing seats, the team owner can assign them to specific users through the management portal.
+
+With an assigned seat, users can seamlessly deploy the application across any of their code repositories.
+
+### Enterprise Account
+
+For organizations who require an Enterprise account, please [contact](https://www.qodo.ai/contact/#pricing) us to initiate a trial period, and to discuss pricing and licensing options.
+
+
+## Install Qodo Merge for GitHub
+
+### GitHub Cloud
+
+Qodo Merge for GitHub cloud is available for installation through the [GitHub Marketplace](https://github.com/apps/qodo-merge-pro).
+
+![Qodo Merge](https://codium.ai/images/pr_agent/pr_agent_pro_install.png){width=468}
+
+### GitHub Enterprise Server
+
+To use Qodo Merge application on your private GitHub Enterprise Server, you will need to [contact](https://www.qodo.ai/contact/#pricing) Qodo for starting an Enterprise trial.
+
+### GitHub Open Source Projects
+
+For open-source projects, Qodo Merge is available for free usage. To install Qodo Merge for your open-source repositories, use the following marketplace [link](https://github.com/apps/qodo-merge-pro-for-open-source).
+
+## Install Qodo Merge for Bitbucket
+
+### Bitbucket Cloud
+
+Qodo Merge for Bitbucket Cloud is available for installation through the following [link](https://bitbucket.org/site/addons/authorize?addon_key=d6df813252c37258)
+
+![Qodo Merge](https://qodo.ai/images/pr_agent/pr_agent_pro_bitbucket_install.png){width=468}
+
+### Bitbucket Server
+
+To use Qodo Merge application on your private Bitbucket Server, you will need to contact us for starting an [Enterprise](https://www.qodo.ai/pricing/) trial.
+
+## Install Qodo Merge for GitLab
+
+### GitLab Cloud
+
+Since GitLab platform does not support apps, installing Qodo Merge for GitLab is a bit more involved, and requires the following steps:
+
+#### Step 1
+
+Acquire a personal, project or group level access token. Enable the “api” scope in order to allow Qodo Merge to read pull requests, comment and respond to requests.
+
+<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.
+
+#### Step 2
+
+Generate a shared secret and link it to the access token. Browse to [https://register.gitlab.pr-agent.codium.ai](https://register.gitlab.pr-agent.codium.ai).
+Fill in your generated GitLab token and your company or personal name in the appropriate fields and click "Submit".
+
+You should see "Success!" displayed above the Submit button, and a shared secret will be generated. Store it in a safe place, you won’t be able to access it again after it was generated.
+
+#### Step 3
+
+Install a webhook for your repository or groups, by clicking “webhooks” on the settings menu. Click the “Add new webhook” button.
+
+<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
+
+Secret token: Your QodoAI key
+Trigger: Check the ‘comments’ and ‘merge request events’ boxes.
+Enable SSL verification: Check the box.
+
+<figure markdown="1">
+![Step 3.2](https://www.codium.ai/images/pr_agent/gitlab_pro_webhooks.png){width=750}
+</figure>
+
+#### Step 4
+
+You’re all set!
+
+Open a new merge request or add a MR comment with one of Qodo Merge’s commands such as /review, /describe or /improve.
+
+### GitLab Server
+
+For a trial period of two weeks on your private GitLab Server, the same [installation steps](#gitlab-cloud) as for GitLab Cloud apply. After the trial period, you will need to [contact](https://www.qodo.ai/contact/#pricing) Qodo for moving to an Enterprise account.

docs/docs/overview/data_privacy.md

@@ -0,0 +1,15 @@
+## Self-hosted PR-Agent
+
+- If you self-host PR-Agent with your OpenAI (or other LLM provider) API key, it is between you and the provider. We don't send your code data to Qodo servers.
+
+## Qodo Merge 💎
+
+- When using Qodo Merge💎, hosted by Qodo, we will not store any of your data, nor will we use it for training. You will also benefit from an OpenAI account with zero data retention.
+
+- For certain clients, Qodo Merge will use Qodo’s proprietary models. If this is the case, you will be notified.
+
+- No passive collection of Code and Pull Requests’ data — Qodo Merge will be active only when you invoke it, and it will then extract and analyze only data relevant to the executed command and queried pull request.
+
+## Qodo Merge Chrome extension
+
+- The [Qodo Merge Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) will not send your code to any external servers.

docs/docs/overview/pr_agent_pro.md

@@ -0,0 +1,51 @@
+### Overview
+
+[Qodo Merge](https://www.codium.ai/pricing/){:target="_blank"} is a paid, hosted version of open-source [PR-Agent](https://github.com/Codium-ai/pr-agent){:target="_blank"}. A complimentary two-week trial is offered, followed by a monthly subscription fee.
+Qodo Merge is designed for companies and teams that require additional features and capabilities. It 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 Qodo Merge app to your GitHub\GitLab\BitBucket repo.
+
+2. **Improved privacy** - No data will be stored or used to train models. Qodo Merge will employ zero data retention, and will use an OpenAI and Claude accounts with zero data retention.
+
+3. **Improved support** - Qodo Merge users will receive priority support, and will be able to request new features and capabilities.
+
+4. **Supporting self-hosted git servers** - Qodo Merge can be installed on GitHub Enterprise Server, GitLab, and BitBucket. For more information, see the [installation guide](https://qodo-merge-docs.qodo.ai/installation/pr_agent_pro/).
+
+5. **PR Chat** - Qodo Merge allows you to engage in [private chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) about your pull requests on private repositories.
+
+### Additional features
+
+Here are some of the additional features and capabilities that Qodo Merge offers, and are not available in the open-source version of PR-Agent:
+
+| Feature                                                                                                              | Description                                                                                                                                            |
+| -------------------------------------------------------------------------------------------------------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [**Model selection**](https://qodo-merge-docs.qodo.ai/usage-guide/PR_agent_pro_models/)                              | Choose the model that best fits your needs, among top models like `Claude Sonnet`, `o4-mini`                                                           |
+| [**Global and wiki configuration**](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/)              | Control configurations for many repositories from a single location; <br>Edit configuration of a single repo without committing code                   |
+| [**Apply suggestions**](https://qodo-merge-docs.qodo.ai/tools/improve/#overview)                                     | Generate committable code from the relevant suggestions interactively by clicking on a checkbox                                                        |
+| [**Suggestions impact**](https://qodo-merge-docs.qodo.ai/tools/improve/#assessing-impact)                            | Automatically mark suggestions that were implemented by the user (either directly in GitHub, or indirectly in the IDE) to enable tracking of the impact of the suggestions |
+| [**CI feedback**](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/)                                                | Automatically analyze failed CI checks on GitHub and provide actionable feedback in the PR conversation, helping to resolve issues quickly             |
+| [**Advanced usage statistics**](https://www.codium.ai/contact/#/)                                                    | Qodo Merge offers detailed statistics at user, repository, and company levels, including metrics about Qodo Merge usage, and also general statistics and insights |
+| [**Incorporating companies' best practices**](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices)         | Use the companies' best practices as reference to increase the effectiveness and the relevance of the code suggestions                                 |
+| [**Interactive triggering**](https://qodo-merge-docs.qodo.ai/tools/analyze/#example-usage)                           | Interactively apply different tools via the `analyze` command                                                                                          |
+| [**Custom labels**](https://qodo-merge-docs.qodo.ai/tools/describe/#handle-custom-labels-from-the-repos-labels-page) | Define custom labels for Qodo Merge to assign to the PR                                                                                                |
+
+### Additional tools
+
+Here are additional tools that are available only for Qodo Merge users:
+
+| Feature                                                                               | Description                                                                                               |
+| ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
+| [**Custom Prompt Suggestions**](https://qodo-merge-docs.qodo.ai/tools/custom_prompt/) | Generate code suggestions based on custom prompts from the user                                           |
+| [**Analyze PR components**](https://qodo-merge-docs.qodo.ai/tools/analyze/)           | Identify the components that changed in the PR, and enable to interactively apply different tools to them |
+| [**Tests**](https://qodo-merge-docs.qodo.ai/tools/test/)                              | Generate tests for code components that changed in the PR                                                 |
+| [**PR documentation**](https://qodo-merge-docs.qodo.ai/tools/documentation/)          | Generate docstring for code components that changed in the PR                                             |
+| [**Improve Component**](https://qodo-merge-docs.qodo.ai/tools/improve_component/)     | Generate code suggestions for code components that changed in the PR                                      |
+| [**Similar code search**](https://qodo-merge-docs.qodo.ai/tools/similar_code/)        | Search for similar code in the repository, organization, or entire GitHub                                 |
+| [**Code implementation**](https://qodo-merge-docs.qodo.ai/tools/implement/)           | Generates implementation code from review suggestions                                                     |
+
+### Supported languages
+
+Qodo Merge leverages the world's leading code models, such as Claude 3.7 Sonnet and o3-mini.
+As a result, its primary tools such as `describe`, `review`, and `improve`, as well as the PR-chat feature, support virtually all programming languages.
+
+For specialized commands that require static code analysis, Qodo Merge offers support for specific languages. For more details about features that require static code analysis, please refer to the [documentation](https://qodo-merge-docs.qodo.ai/tools/analyze/#overview).

docs/docs/pr_benchmark/index.md

@@ -0,0 +1,201 @@
+# Qodo Merge Pull Request Benchmark
+
+## Methodology
+
+Qodo Merge PR Benchmark evaluates and compares the performance of two Large Language Models (LLMs) in analyzing pull request code and providing meaningful code suggestions.
+Our diverse dataset comprises of 400 pull requests from over 100 repositories, spanning various programming languages and frameworks to reflect real-world scenarios.
+
+- For each pull request, two distinct LLMs process the same prompt using the Qodo Merge `improve` tool, each generating two sets of responses. The prompt for response generation can be found [here](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/code_suggestions/pr_code_suggestions_prompts_not_decoupled.toml).
+
+- Subsequently, a high-performing third model (an AI judge) evaluates the responses from the initial two models to determine the superior one. We utilize OpenAI's `o3` model as the judge, though other models have yielded consistent results. The prompt for this comparative judgment is available [here](https://github.com/Codium-ai/pr-agent-settings/tree/main/benchmark).
+
+- We aggregate comparison outcomes across all the pull requests, calculating the win rate for each model. We also analyze the qualitative feedback (the "why" explanations from the judge) to identify each model's comparative strengths and weaknesses.
+This approach provides not just a quantitative score but also a detailed analysis of each model's strengths and weaknesses.
+
+- For each model we build a "Model Card", comparing it against others. To ensure full transparency and enable community scrutiny, we also share the raw code suggestions generated by each model, and the judge's specific feedback. See example for the full output [here](https://github.com/Codium-ai/pr-agent-settings/blob/main/benchmark/sonnet_37_vs_gemini-2.5-pro-preview-05-06.md)
+
+Note that this benchmark focuses on quality: the ability of an LLM to process complex pull request with multiple files and nuanced task to produce high-quality code suggestions.
+Other factors like speed, cost, and availability, while also relevant for model selection, are outside this benchmark's scope.
+
+## TL;DR
+
+Here's a summary of the win rates based on the benchmark:
+
+[//]: # (| Model A                        | Model B                        | Model A Win Rate | Model B Win Rate |)
+
+[//]: # (|:-------------------------------|:-------------------------------|:----------------:|:----------------:|)
+
+[//]: # (| Gemini-2.5-pro-preview-05-06   | GPT-4.1                        |      70.4%       |      29.6%       |)
+
+[//]: # (| Gemini-2.5-pro-preview-05-06   | Sonnet 3.7                     |      78.1%       |      21.9%       |)
+
+[//]: # (| GPT-4.1                        | Sonnet 3.7                     |      61.0%       |      39.0%       |)
+
+<table>
+  <thead>
+    <tr>
+      <th style="text-align:left;">Model A</th>
+      <th style="text-align:left;">Model B</th>
+      <th style="text-align:center;">Model A Win Rate</th> <th style="text-align:center;">Model B Win Rate</th> </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td style="text-align:left;">Gemini-2.5-pro-preview-05-06</td>
+      <td style="text-align:left;">GPT-4.1</td>
+      <td style="text-align:center; color: #1E8449;"><b>70.4%</b></td> <td style="text-align:center; color: #D8000C;"><b>29.6%</b></td> </tr>
+    <tr>
+      <td style="text-align:left;">Gemini-2.5-pro-preview-05-06</td>
+      <td style="text-align:left;">Sonnet 3.7</td>
+      <td style="text-align:center; color: #1E8449;"><b>78.1%</b></td> <td style="text-align:center; color: #D8000C;"><b>21.9%</b></td> </tr>
+    <tr>
+      <td style="text-align:left;">Gemini-2.5-pro-preview-05-06</td>
+      <td style="text-align:left;">Gemini-2.5-flash-preview-04-17</td>
+      <td style="text-align:center; color: #1E8449;"><b>73.0%</b></td> <td style="text-align:center; color: #D8000C;"><b>27.0%</b></td> </tr>
+    <tr>
+      <td style="text-align:left;">Gemini-2.5-flash-preview-04-17</td>
+      <td style="text-align:left;">GPT-4.1</td>
+      <td style="text-align:center; color: #1E8449;"><b>54.6%</b></td> <td style="text-align:center; color: #D8000C;"><b>45.4%</b></td> </tr>
+    <tr>
+      <td style="text-align:left;">Gemini-2.5-flash-preview-04-17</td>
+      <td style="text-align:left;">Sonnet 3.7</td>
+      <td style="text-align:center; color: #1E8449;"><b>60.6%</b></td> <td style="text-align:center; color: #D8000C;"><b>39.4%</b></td> </tr>
+    <tr>
+      <td style="text-align:left;">GPT-4.1</td>
+      <td style="text-align:left;">Sonnet 3.7</td>
+      <td style="text-align:center; color: #1E8449;"><b>61.0%</b></td> <td style="text-align:center; color: #D8000C;"><b>39.0%</b></td> </tr>
+  </tbody>
+</table>
+
+
+## Gemini-2.5-pro-preview-05-06 - Model Card
+
+### Comparison against GPT-4.1
+
+![Comparison](https://codium.ai/images/qodo_merge_benchmark/gpt-4.1_vs_gemini-2.5-pro-preview-05-06_judge_o3.png){width=768}
+
+#### Analysis Summary
+
+Model 'Gemini-2.5-pro-preview-05-06' is generally more useful thanks to wider and more accurate bug detection and concrete patches, but it sacrifices compliance discipline and sometimes oversteps the task rules. Model 'GPT-4.1' is safer and highly rule-abiding, yet often too timid—missing many genuine issues and providing limited insight. An ideal reviewer would combine 'GPT-4.1’ restraint with 'Gemini-2.5-pro-preview-05-06' thoroughness.
+
+#### Detailed Analysis
+
+Gemini-2.5-pro-preview-05-06 strengths:  
+
+- better_bug_coverage: Detects and explains more critical issues, winning in ~70 % of comparisons and achieving a higher average score.  
+- actionable_fixes: Supplies clear code snippets, correct language labels, and often multiple coherent suggestions per diff.  
+- deeper_reasoning: Shows stronger grasp of logic, edge cases, and cross-file implications, leading to broader, high-impact reviews.  
+
+Gemini-2.5-pro-preview-05-06 weaknesses:  
+
+- guideline_violations: More prone to over-eager advice—non-critical tweaks, touching unchanged code, suggesting new imports, or minor format errors.  
+- occasional_overreach: Some fixes are speculative or risky, potentially introducing new bugs.  
+- redundant_or_duplicate: At times repeats the same point or exceeds the required brevity.  
+
+
+### Comparison against Sonnet 3.7
+
+![Comparison](https://codium.ai/images/qodo_merge_benchmark/sonnet_37_vs_gemini-2.5-pro-preview-05-06_judge_o3.png){width=768}
+
+#### Analysis Summary
+
+Model 'Gemini-2.5-pro-preview-05-06' is the stronger reviewer—more frequently identifies genuine, high-impact bugs and provides well-formed, actionable fixes. Model 'Sonnet 3.7' is safer against false positives and tends to be concise but often misses important defects or offers low-value or incorrect suggestions.
+
+See raw results [here](https://github.com/Codium-ai/pr-agent-settings/blob/main/benchmark/sonnet_37_vs_gemini-2.5-pro-preview-05-06.md)
+
+
+#### Detailed Analysis
+
+Gemini-2.5-pro-preview-05-06 strengths:  
+
+- higher_accuracy_and_coverage: finds real critical bugs and supplies actionable patches in most examples (better in 78 % of cases).  
+- guideline_awareness: usually respects new-lines-only scope, ≤3 suggestions, proper YAML, and stays silent when no issues exist.  
+- detailed_reasoning_and_patches: explanations tie directly to the diff and fixes are concrete, often catching multiple related defects that 'Sonnet 3.7' overlooks.
+
+Gemini-2.5-pro-preview-05-06 weaknesses:  
+
+- occasional_rule_violations: sometimes proposes new imports, package-version changes, or edits outside the added lines.  
+- overzealous_suggestions: may add speculative or stylistic fixes that exceed the “critical” scope, or mis-label severity.  
+- sporadic_technical_slips: a few patches contain minor coding errors, oversized snippets, or duplicate/contradicting advice.
+
+## GPT-4.1 - Model Card
+
+### Comparison against Sonnet 3.7
+
+![Comparison](https://codium.ai/images/qodo_merge_benchmark/gpt-4.1_vs_sonnet_3.7_judge_o3.png){width=768}
+
+#### Analysis Summary
+
+Model 'GPT-4.1' is safer and more compliant, preferring silence over speculation, which yields fewer rule breaches and false positives but misses some real bugs.  
+Model 'Sonnet 3.7' is more adventurous and often uncovers important issues that 'GPT-4.1' ignores, yet its aggressive style leads to frequent guideline violations and a higher proportion of incorrect or non-critical advice. 
+
+See raw results [here](https://github.com/Codium-ai/pr-agent-settings/blob/main/benchmark/gpt-4.1_vs_sonnet_3.7_judge_o3.md)
+
+
+#### Detailed Analysis
+
+GPT-4.1 strengths:  
+- Strong guideline adherence: usually stays strictly on `+` lines, avoids non-critical or stylistic advice, and rarely suggests forbidden imports; often outputs an empty list when no real bug exists.  
+- Lower false-positive rate: suggestions are more accurate and seldom introduce new bugs; fixes compile more reliably.  
+- Good schema discipline: YAML is almost always well-formed and fields are populated correctly.  
+
+GPT-4.1 weaknesses:  
+- Misses bugs: often returns an empty list even when a clear critical issue is present, so coverage is narrower.  
+- Sparse feedback: when it does comment, it tends to give fewer suggestions and sometimes lacks depth or completeness.  
+- Occasional metadata/slip-ups (wrong language tags, overly broad code spans), though less harmful than Sonnet 3.7 errors.  
+
+### Comparison against Gemini-2.5-pro-preview-05-06
+
+![Comparison](https://codium.ai/images/qodo_merge_benchmark/gpt-4.1_vs_gemini-2.5-pro-preview-05-06_judge_o3.png){width=768}
+
+#### Analysis Summary
+
+Model 'Gemini-2.5-pro-preview-05-06' is generally more useful thanks to wider and more accurate bug detection and concrete patches, but it sacrifices compliance discipline and sometimes oversteps the task rules. Model 'GPT-4.1' is safer and highly rule-abiding, yet often too timid—missing many genuine issues and providing limited insight. An ideal reviewer would combine 'GPT-4.1’ restraint with 'Gemini-2.5-pro-preview-05-06' thoroughness.
+
+#### Detailed Analysis
+
+GPT-4.1 strengths: 
+- strict_compliance: Usually sticks to the “critical bugs only / new ‘+’ lines only” rule, so outputs rarely violate task constraints.  
+- low_risk: Conservative behaviour avoids harmful or speculative fixes; safer when no obvious issue exists.  
+- concise_formatting: Tends to produce minimal, correctly-structured YAML without extra noise.  
+
+GPT-4.1 weaknesses:
+- under_detection: Frequently returns an empty list even when real bugs are present, missing ~70 % of the time.  
+- shallow_analysis: When it does suggest fixes, coverage is narrow and technical depth is limited, sometimes with wrong language tags or minor format slips.  
+- occasional_inaccuracy: A few suggestions are unfounded or duplicate, and rare guideline breaches (e.g., import advice) still occur.  
+
+
+## Sonnet 3.7 - Model Card
+
+### Comparison against GPT-4.1
+
+![Comparison](https://codium.ai/images/qodo_merge_benchmark/gpt-4.1_vs_sonnet_3.7_judge_o3.png){width=768}
+
+#### Analysis Summary
+
+Model 'GPT-4.1' is safer and more compliant, preferring silence over speculation, which yields fewer rule breaches and false positives but misses some real bugs.  
+Model 'Sonnet 3.7' is more adventurous and often uncovers important issues that 'GPT-4.1' ignores, yet its aggressive style leads to frequent guideline violations and a higher proportion of incorrect or non-critical advice. 
+
+See raw results [here](https://github.com/Codium-ai/pr-agent-settings/blob/main/benchmark/gpt-4.1_vs_sonnet_3.7_judge_o3.md)
+
+#### Detailed Analysis
+
+'Sonnet 3.7' strengths:
+- Better bug discovery breadth: more willing to dive into logic and spot critical problems that 'GPT-4.1' overlooks; often supplies multiple, detailed fixes.  
+- Richer explanations & patches: gives fuller context and, when correct, proposes more functional or user-friendly solutions.  
+- Generally correct language/context tagging and targeted code snippets.  
+
+'Sonnet 3.7' weaknesses:
+- Guideline violations: frequently flags non-critical issues, edits untouched code, or recommends adding imports, breaching task rules.  
+- Higher error rate: suggestions are more speculative and sometimes introduce new defects or duplicate work already done.  
+- Occasional schema or formatting mistakes (missing list value, duplicated suggestions), reducing reliability.  
+
+
+### Comparison against Gemini-2.5-pro-preview-05-06
+
+![Comparison](https://codium.ai/images/qodo_merge_benchmark/sonnet_37_vs_gemini-2.5-pro-preview-05-06_judge_o3.png){width=768}
+
+#### Analysis Summary
+
+Model 'Gemini-2.5-pro-preview-05-06' is the stronger reviewer—more frequently identifies genuine, high-impact bugs and provides well-formed, actionable fixes. Model 'Sonnet 3.7' is safer against false positives and tends to be concise but often misses important defects or offers low-value or incorrect suggestions.
+
+See raw results [here](https://github.com/Codium-ai/pr-agent-settings/blob/main/benchmark/sonnet_37_vs_gemini-2.5-pro-preview-05-06.md)

docs/docs/recent_updates/index.md

@@ -0,0 +1,22 @@
+# Recent Updates and Future Roadmap
+
+`Page last updated: 2025-05-11`
+
+This page summarizes recent enhancements to Qodo Merge (last three months).
+
+It also outlines our development roadmap for the upcoming three months. Please note that the roadmap is subject to change, and features may be adjusted, added, or reprioritized.
+
+=== "Recent Updates"
+    - **Qodo Merge Pull Request Benchmark** - evaluating the performance of LLMs in analyzing pull request code ([Learn more](https://qodo-merge-docs.qodo.ai/pr_benchmark/))
+    - **Chat on Suggestions**:  Users can now chat with Qodo Merge code suggestions ([Learn more](https://qodo-merge-docs.qodo.ai/tools/improve/#chat-on-code-suggestions))
+    - **Scan Repo Discussions Tool**: A new tool that analyzes past code discussions to generate a `best_practices.md` file, distilling key insights and recommendations. ([Learn more](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/))
+    - **Enhanced Models**: Qodo Merge now defaults to a combination of top models (Claude Sonnet 3.7 and Gemini 2.5 Pro) and incorporates dedicated code validation logic for improved results. ([Details 1](https://qodo-merge-docs.qodo.ai/usage-guide/qodo_merge_models/), [Details 2](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/))
+    - **Chrome Extension Update**: Qodo Merge Chrome extension now supports single-tenant users. ([Learn more](https://qodo-merge-docs.qodo.ai/chrome-extension/options/#configuration-options/))
+    - **Repo Statistics Tool**: A new tool that provides repository statistics on time to merge and time to first comment. ([Learn more](https://qodo-merge-docs.qodo.ai/tools/repo_statistics/))
+
+=== "Future Roadmap"
+    - **Smart Update**: Upon PR updates, Qodo Merge will offer tailored code suggestions, addressing both the entire PR and the specific incremental changes since the last feedback.
+    - **CLI Endpoint**: A new Qodo Merge endpoint will accept lists of before/after code changes, execute Qodo Merge commands, and return the results.
+    - **Simplified Free Tier**: We plan to transition from a two-week free trial to a free tier offering a limited number of suggestions per month per organization.
+    - **Best Practices Hierarchy**: Introducing support for structured best practices, such as for folders in monorepos or a unified best practice file for a group of repositories.
+    - **Installation Metrics**: Upon installation, Qodo Merge will analyze past PRs for key metrics (e.g., time to merge, time to first reviewer feedback), enabling pre/post-installation comparison to calculate ROI.

docs/docs/tools/analyze.md

@@ -0,0 +1,20 @@
+## Overview
+
+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, finds 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:
+
+```
+/analyze
+```
+
+## Example usage
+
+An example result:
+
+![Analyze 1](https://codium.ai/images/pr_agent/analyze_1.png){width=750}
+
+!!! note "Language that are currently supported:"
+    Python, Java, C++, JavaScript, TypeScript, C#.

docs/docs/tools/ask.md

@@ -0,0 +1,62 @@
+## Overview
+
+The `ask` tool answers questions about the PR, based on the PR code changes. Make sure to be specific and clear in your questions.
+It can be invoked manually by commenting on any PR:
+
+```
+/ask "..."
+```
+
+## Example usage
+
+![Ask Comment](https://codium.ai/images/pr_agent/ask_comment.png){width=512}
+
+![Ask](https://codium.ai/images/pr_agent/ask.png){width=512}
+
+## Ask lines
+
+You can run `/ask` on specific lines of code in the PR from the PR's diff view. The tool will answer questions based on the code changes in the selected lines.
+
+- Click on the '+' sign next to the line number to select the line.
+- 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.
+
+![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

@@ -0,0 +1,43 @@
+## Overview
+
+The CI feedback tool (`/checks)` automatically triggers when a PR has a failed check.
+The tool analyzes the failed checks and provides several feedbacks:
+
+- Failed stage
+- Failed test name
+- Failure summary
+- Relevant error logs
+
+## Example usage
+
+![Failed Check 1](https://www.codium.ai/images/pr_agent/failed_check1.png){width=768}
+
+→
+![Failed Check 2](https://www.codium.ai/images/pr_agent/failed_check2.png){width=768}
+
+___
+
+In addition to being automatically triggered, the tool can also be invoked manually by commenting on a PR:
+
+```
+/checks "https://github.com/{repo_name}/actions/runs/{run_number}/job/{job_number}"
+```
+
+where `{repo_name}` is the name of the repository, `{run_number}` is the run number of the failed check, and `{job_number}` is the job number of the failed check.
+
+## Disabling the tool from running automatically
+
+If you wish to disable the tool from running automatically, you can do so by adding the following configuration to the configuration file:
+
+```
+[checks]
+enable_auto_checks_feedback = false
+```
+
+## Configuration options
+
+- `enable_auto_checks_feedback` - if set to true, the tool will automatically provide feedback when a check is failed. Default is true.
+- `excluded_checks_list` - a list of checks to exclude from the feedback, for example: ["check1", "check2"]. Default is an empty list.
+- `persistent_comment` - if set to true, the tool will overwrite a previous checks comment with the new feedback. Default is true.
+- `enable_help_text=true` - if set to true, the tool will provide a help message when a user comments "/checks" on a PR. Default is true.
+- `final_update_message` - if `persistent_comment` is true and updating a previous checks message, the tool will also create a new message: "Persistent checks updated to latest commit". Default is true.

docs/docs/tools/custom_labels.md

@@ -0,0 +1,68 @@
+## Overview
+
+The `generate_labels` tool scans the PR code changes, and given a list of labels and their descriptions, it automatically suggests labels that match the PR code changes.
+
+It can be invoked manually by commenting on any PR:
+
+```
+/generate_labels
+```
+
+## Example usage
+
+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:
+
+![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:
+
+![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.
+
+### How to enable custom labels
+
+There are 3 ways to enable custom labels:
+
+#### 1. CLI (local configuration file)
+
+When working from CLI, you need to apply the [configuration changes](#configuration-options) to the [custom_labels file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/custom_labels.toml):
+
+#### 2. Repo configuration file
+
+To enable custom labels, you need to apply the [configuration changes](#configuration-options) to the local `.pr_agent.toml` file in your repository.
+
+#### 3. Handle custom labels from the Repo's labels page 💎
+
+> This feature is available only in Qodo Merge
+
+* GitHub : `https://github.com/{owner}/{repo}/labels`, or click on the "Labels" tab in the issues or PRs page.
+* GitLab : `https://gitlab.com/{owner}/{repo}/-/labels`, or click on "Manage" -> "Labels" on the left menu.
+
+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.
+
+![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.
+
+> This feature is supported in GitHub and GitLab.
+
+## Configuration options
+
+* Change `enable_custom_labels` to True: This will turn off the default labels and enable the custom labels provided in the custom_labels.toml file.
+* Add the custom labels. It should be formatted as follows:
+
+```
+[config]
+enable_custom_labels=true
+
+[custom_labels."Custom Label Name"]
+description = "Description of when AI should suggest this label"
+
+[custom_labels."Custom Label 2"]
+description = "Description of when AI should suggest this label 2"
+```

docs/docs/tools/custom_prompt.md

@@ -0,0 +1,60 @@
+## Overview
+
+The `custom_prompt` tool scans the PR code changes, and automatically generates suggestions for improving the PR code.
+It shares similarities with the `improve` tool, but with one main difference: the `custom_prompt` tool will **only propose suggestions that follow specific guidelines defined by the prompt** in: `pr_custom_prompt.prompt` configuration.
+
+The tool can be triggered [automatically](../usage-guide/automations_and_usage.md#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.
+
+When commenting, use the following template:
+
+```
+/custom_prompt --pr_custom_prompt.prompt="
+The code suggestions should focus only on the following:
+- ...
+- ...
+
+"
+```
+
+With a [configuration file](../usage-guide/automations_and_usage.md#github-app), use the following template:
+
+```toml
+[pr_custom_prompt]
+prompt="""\
+The suggestions should focus only on the following:
+-...
+-...
+
+"""
+```
+
+Remember - with this tool, you are the prompter. Be specific, clear, and concise in the instructions. Specify relevant aspects that you want the model to focus on. \
+You might benefit from several trial-and-error iterations, until you get the correct prompt for your use case.
+
+## Example usage
+
+Here is an example of a possible prompt, defined in the configuration file:
+
+```toml
+[pr_custom_prompt]
+prompt="""\
+The code suggestions should focus only on the following:
+- look for edge cases when implementing a new function
+- make sure every variable has a meaningful name
+- make sure the code is efficient
+"""
+```
+
+(The instructions above are just an example. We want to emphasize that the prompt should be specific and clear, and be tailored to the needs of your project)
+
+Results obtained with the prompt above:
+
+![Custom prompt results](https://codium.ai/images/pr_agent/custom_suggestions_result.png){width=768}
+
+## Configuration options
+
+- `prompt`: the prompt for the tool. It should be a multi-line string.
+
+- `num_code_suggestions_per_chunk`: number of code suggestions provided by the 'custom_prompt' tool, per chunk. Default is 3.
+
+- `enable_help_text`: if set to true, the tool will display a help text in the comment. Default is true.

docs/docs/tools/describe.md

@@ -0,0 +1,240 @@
+## Overview
+
+The `describe` tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels.
+
+The tool can be triggered automatically every time a new PR is [opened](../usage-guide/automations_and_usage.md#github-app-automatic-tools-when-a-new-pr-is-opened), or it can be invoked manually by commenting on any PR:
+
+```
+/describe
+```
+
+## Example usage
+
+### Manual triggering
+
+Invoke the tool manually by commenting `/describe` on any PR:
+
+![Describe comment](https://codium.ai/images/pr_agent/describe_comment.png){width=512}
+
+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](#configuration-options), add the relevant ones to the command:
+
+```
+/describe --pr_description.some_config1=... --pr_description.some_config2=...
+```
+
+### Automatic triggering
+
+To run the `describe` automatically when a PR is opened, define in a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file):
+
+```
+[github_app]
+pr_commands = [
+    "/describe",
+    ...
+]
+
+[pr_description]
+publish_labels = true
+...
+```
+
+- The `pr_commands` lists commands that will be executed automatically when a PR is opened.
+- The `[pr_description]` section contains the configurations for the `describe` tool you want to edit (if any).
+
+## Preserving the original user description
+
+By default, Qodo Merge preserves your original PR description by placing it above the generated content.
+This requires including your description during the initial PR creation.
+Be aware that if you edit the description while the automated tool is running, a race condition may occur, potentially causing your original description to be lost.
+
+When updating PR descriptions, the `/describe` tool considers everything above the "PR Type" field as user content and will preserve it.
+Everything below this marker is treated as previously auto-generated content and will be replaced.
+
+![Describe comment](https://codium.ai/images/pr_agent/pr_description_user_description.png){width=512}
+
+## Configuration options
+
+!!! example "Possible configurations"
+
+    <table>
+      <tr>
+        <td><b>publish_labels</b></td>
+        <td>If set to true, the tool will publish labels to the PR. Default is false.</td>
+      </tr>
+      <tr>
+        <td><b>publish_description_as_comment</b></td>
+        <td>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.</td>
+      </tr>
+      <tr>
+        <td><b>publish_description_as_comment_persistent</b></td>
+        <td>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.</td>
+      </tr>
+      <tr>
+        <td><b>add_original_user_description</b></td>
+        <td>If set to true, the tool will add the original user description to the generated description. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>generate_ai_title</b></td>
+        <td>If set to true, the tool will also generate an AI title for the PR. Default is false.</td>
+      </tr>
+      <tr>
+        <td><b>extra_instructions</b></td>
+        <td>Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ..."</td>
+      </tr>
+      <tr>
+        <td><b>enable_pr_type</b></td>
+        <td>If set to false, it will not show the `PR type` as a text value in the description content. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>final_update_message</b></td>
+        <td>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 false.</td>
+      </tr>
+      <tr>
+        <td><b>enable_semantic_files_types</b></td>
+        <td>If set to true, "Changes walkthrough" section will be generated. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>collapsible_file_list</b></td>
+        <td>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".</td>
+      </tr>
+      <tr>
+        <td><b>enable_large_pr_handling</b></td>
+        <td>Pro feature. If set to true, in case of a large PR the tool will make several calls to the AI and combine them to be able to cover more files. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>enable_help_text</b></td>
+        <td>If set to true, the tool will display a help text in the comment. Default is false.</td>
+      </tr>
+    </table>
+
+## Inline file summary 💎
+
+This feature enables you to copy the `changes walkthrough` table to the "Files changed" tab, so you can quickly understand the changes in each file while reviewing the code changes (diff view).
+
+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:
+
+![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.
+
+![Diffview table](https://codium.ai/images/pr_agent/diffview-table.png){width=512}
+
+- `true`: A collapsible file comment with changes title and a changes summary for each file in the PR.
+
+![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.
+
+## Markers template
+
+To enable markers, set `pr_description.use_description_markers=true`.
+Markers enable to easily integrate user's content and auto-generated content, with a template-like mechanism.
+
+For example, if the PR original description was:
+
+```
+User content...
+
+## PR Type:
+pr_agent:type
+
+## PR Description:
+pr_agent:summary
+
+## PR Walkthrough:
+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.
+
+![Describe markers before](https://codium.ai/images/pr_agent/describe_markers_before.png){width=512}
+
+becomes
+
+![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://qodo-merge-docs.qodo.ai/tools/custom_labels/#configuration-options), or directly in the repo's [labels page](#handle-custom-labels-from-the-repos-labels-page).
+
+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 a configuration file
+
+Example for a custom labels configuration setup in a configuration file:
+
+```
+[config]
+enable_custom_labels=true
+
+
+[custom_labels."sql_changes"]
+description = "Use when a PR contains changes to SQL queries"
+
+[custom_labels."test"]
+description = "use when a PR primarily contains new tests"
+
+...
+```
+
+### Handle custom labels from the Repo's labels page 💎
+
+You can also 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>
+
+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 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
+
+!!! tip "Automation"
+    - When you first install Qodo Merge app, the [default mode](../usage-guide/automations_and_usage.md#github-app) for the describe tool is:
+    ```
+    pr_commands = ["/describe", ...]
+    ```
+    meaning the `describe` tool will run automatically on every PR, with the default configurations.
+
+- Markers are an alternative way to control the generated description, to give maximal control to the user. If you set:
+
+   ```
+   pr_commands = ["/describe --pr_description.use_description_markers=true", ...]
+   ```
+
+   the tool will replace every marker of the form `pr_agent:marker_name` in the PR description with the relevant content, where `marker_name` is one of the following:
+         *`type`: the PR type.
+         * `summary`: the PR 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.

docs/docs/tools/documentation.md

@@ -0,0 +1,36 @@
+## Overview
+
+The `add_docs` tool scans the PR code changes, and automatically suggests documentation for any code components that changed in the PR (functions, classes, etc.).
+
+It can be invoked manually by commenting on any PR:
+
+```
+/add_docs
+```
+
+## Example usage
+
+Invoke the tool manually by commenting `/add_docs` on any PR:
+
+![Docs command](https://codium.ai/images/pr_agent/docs_command.png){width=768}
+
+The tool will generate documentation for all the components that changed in the PR:
+
+![Docs component](https://codium.ai/images/pr_agent/docs_components.png){width=768}
+
+![Docs single component](https://codium.ai/images/pr_agent/docs_single_component.png){width=768}
+
+You can state a name of a specific component in the PR to get documentation only for that component:
+
+```
+/add_docs component_name
+```
+
+## 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`.
+- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
+
+!!! note "Notes"
+    - The following languages are currently supported: Python, Java, C++, JavaScript, TypeScript, C#.
+    - This tool can also be triggered interactively by using the [`analyze`](./analyze.md) tool.

docs/docs/tools/help.md

@@ -0,0 +1,20 @@
+## Overview
+
+The `help` tool provides a list of all the available tools and their descriptions.
+For Qodo Merge 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/help_docs.md

@@ -0,0 +1,110 @@
+## Overview
+
+The `help_docs` tool can answer a free-text question based on a git documentation folder.
+
+It can be invoked manually by commenting on any PR or Issue:
+
+```
+/help_docs "..."
+```
+
+Or configured to be triggered automatically when a [new issue is opened](#run-as-a-github-action).
+
+The tool assumes by default that the documentation is located in the root of the repository, at `/docs` folder.
+However, this can be customized by setting the `docs_path` configuration option:
+
+```toml
+[pr_help_docs]
+repo_url = ""                 # The repository to use as context
+docs_path = "docs"            # The documentation folder
+repo_default_branch = "main"  # The branch to use in case repo_url overwritten
+
+```
+
+See more configuration options in the [Configuration options](#configuration-options) section.
+
+## Example usage
+
+[//]: # (#### Asking a question about this repository:)
+
+[//]: # (![help_docs on the documentation of this repository](https://codium.ai/images/pr_agent/help_docs_comment.png){width=512})
+
+**Asking a question about another repository**
+
+![help_docs on the documentation of another repository](https://codium.ai/images/pr_agent/help_docs_comment_explicit_git.png){width=512}
+
+**Response**:
+
+![help_docs response](https://codium.ai/images/pr_agent/help_docs_response.png){width=512}
+
+## Run automatically when a new issue is opened
+
+You can configure PR-Agent to run `help_docs` automatically on any newly created issue.
+This can be useful, for example, for providing immediate feedback to users who open issues with questions on open-source projects with extensive documentation.
+
+Here's how:
+
+1) Follow the steps depicted under [Run as a Github Action](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action) to create a new workflow, such as:`.github/workflows/help_docs.yml`:
+
+2) Edit your yaml file to the following:
+
+```yaml
+name: Run pr agent on every opened issue, respond to user comments on an issue
+
+#When the action is triggered
+on:
+  issues:
+    types: [opened] #New issue
+
+# Read env. variables
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  GITHUB_API_URL: ${{ github.api_url }}
+  GIT_REPO_URL: ${{ github.event.repository.clone_url }}
+  ISSUE_URL: ${{ github.event.issue.html_url || github.event.comment.html_url }}
+  ISSUE_BODY: ${{ github.event.issue.body || github.event.comment.body }}
+  OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
+
+# The actual set of actions
+jobs:
+  issue_agent:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.sender.type != 'Bot' }} #Do not respond to bots
+
+    # Set required permissions
+    permissions:
+      contents: read    # For reading repository contents
+      issues: write     # For commenting on issues
+
+    steps:
+      - name: Run PR Agent on Issues
+        if: ${{ env.ISSUE_URL != '' }}
+        uses: docker://codiumai/pr-agent:latest
+        with:
+          entrypoint: /bin/bash #Replace invoking cli.py directly with a shell
+          args: |
+            -c "cd /app && \
+            echo 'Running Issue Agent action step on ISSUE_URL=$ISSUE_URL' && \
+            export config__git_provider='github' && \
+            export github__user_token=$GITHUB_TOKEN && \            
+            export github__base_url=$GITHUB_API_URL && \
+            export openai__key=$OPENAI_KEY && \
+            python -m pr_agent.cli --issue_url=$ISSUE_URL --pr_help_docs.repo_url="..." --pr_help_docs.docs_path="..." --pr_help_docs.openai_key=$OPENAI_KEY && \help_docs \"$ISSUE_BODY\""
+```
+
+3) Following completion of the remaining steps (such as adding secrets and relevant configurations, such as `repo_url` and `docs_path`) merge this change to your main branch.
+When a new issue is opened, you should see a comment from `github-actions` bot with an auto response, assuming the question is related to the documentation of the repository.
+
+---
+
+## Configuration options
+
+Under the section `pr_help_docs`, the [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L50) contains options to customize the 'help docs' tool:
+
+- `repo_url`: If not overwritten, will use the repo from where the context came from (issue or PR), otherwise - use the given repo as context.
+- `repo_default_branch`: The branch to use in case repo_url overwritten, otherwise - has no effect.
+- `docs_path`: Relative path from root of repository (either the one this PR has been issued for, or above repo url).
+- `exclude_root_readme`:  Whether or not to exclude the root README file for querying the model.
+- `supported_doc_exts` : Which file extensions should be included for the purpose of querying the model.
+
+---

docs/docs/tools/implement.md

@@ -0,0 +1,57 @@
+`Platforms supported: GitHub, GitLab, Bitbucket`
+
+## Overview
+
+The `implement` tool converts human code review discussions and feedback into ready-to-commit code changes.
+It leverages LLM technology to transform PR comments and review suggestions into concrete implementation code, helping developers quickly turn feedback into working solutions.
+
+## Usage Scenarios
+
+### For Reviewers
+
+Reviewers can request code changes by:
+
+1. Selecting the code block to be modified.
+2. Adding a comment with the syntax:
+
+```
+/implement <code-change-description>
+```
+
+![implement1](https://codium.ai/images/pr_agent/implement1.png){width=640}
+
+### For PR Authors
+
+PR authors can implement suggested changes by replying to a review comment using either: <br>
+
+1. Add specific implementation details as described above
+
+```
+/implement <code-change-description>
+```
+
+2. Use the original review comment as instructions
+
+```
+/implement
+```
+
+![implement2](https://codium.ai/images/pr_agent/implement2.png){width=640}
+
+### For Referencing Comments
+
+You can reference and implement changes from any comment by:
+
+```
+/implement <link-to-review-comment>
+```
+
+![implement3](https://codium.ai/images/pr_agent/implement3.png){width=640}
+
+Note that the implementation will occur within the review discussion thread.
+
+**Configuration options**
+
+- Use `/implement` to implement code change within and based on the review discussion.
+- Use `/implement <code-change-description>` inside a review discussion to implement specific instructions.
+- Use `/implement <link-to-review-comment>` to indirectly call the tool from any comment.

docs/docs/tools/improve.md

@@ -0,0 +1,570 @@
+## Overview
+
+The `improve` tool scans the PR code changes, and automatically generates meaningful suggestions for improving the PR code.
+The tool can be triggered automatically every time a new PR is [opened](../usage-guide/automations_and_usage.md#github-app-automatic-tools-when-a-new-pr-is-opened), or it can be invoked manually by commenting on any PR:
+
+```toml
+/improve
+```
+
+## How it looks
+
+=== "Suggestions Overview"
+    ![code_suggestions_as_comment_closed](https://codium.ai/images/pr_agent/code_suggestions_as_comment_closed.png){width=512}
+
+=== "Selecting a specific suggestion"
+    ![code_suggestions_as_comment_open](https://codium.ai/images/pr_agent/code_suggestions_as_comment_open.png){width=512}
+
+___
+
+!!! note "The following features are available only for Qodo Merge 💎 users:"
+    - The `Apply / Chat` checkbox, which interactively converts a suggestion into a committable code comment
+    - The `More` checkbox to generate additional suggestions
+    - On Bitbucket (Cloud & Data Center) and GitLab Server (v16 and earlier), you can invoke [More Suggestions manually](#manual-more-suggestions)
+
+## Example usage
+
+### Manual triggering
+
+Invoke the tool manually by commenting `/improve` on any PR. The code suggestions by default are presented as a single comment:
+
+To edit [configurations](#configuration-options) related to the `improve` tool, use the following template:
+
+```toml
+/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
+```
+
+For example, you can choose to present all the suggestions as committable code comments, by running the following command:
+
+```toml
+/improve --pr_code_suggestions.commitable_code_suggestions=true
+```
+
+![improve](https://codium.ai/images/pr_agent/improve.png){width=512}
+
+As can be seen, a single table 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 can only be presented in Bitbucket as code comments.
+
+#### Manual more suggestions
+To generate more suggestions (distinct from the ones already generated), for git-providers that don't support interactive checkbox option, you can manually run:
+
+```
+/improve --more_suggestions=true
+```
+
+### Automatic triggering
+
+To run the `improve` automatically when a PR is opened, define in a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file):
+
+```toml
+[github_app]
+pr_commands = [
+    "/improve",
+    ...
+]
+
+[pr_code_suggestions]
+num_code_suggestions_per_chunk = ...
+...
+```
+
+- The `pr_commands` lists commands that will be executed automatically when a PR is opened.
+- The `[pr_code_suggestions]` section contains the configurations for the `improve` tool you want to edit (if any)
+
+### Assessing Impact
+
+>`💎 feature`
+
+Qodo Merge tracks two types of implementations for tracking implemented suggestions:
+
+- Direct implementation - when the user directly applies the suggestion by clicking the `Apply` checkbox.
+- Indirect implementation - when the user implements the suggestion in their IDE environment. In this case, Qodo Merge will utilize, after each commit, a dedicated logic to identify if a suggestion was implemented, and will mark it as implemented.
+
+![code_suggestions_assess_impact](https://codium.ai/images/pr_agent/code_suggestions_asses_impact.png){width=512}
+
+In post-process, Qodo Merge counts the number of suggestions that were implemented, and provides general statistics and insights about the suggestions' impact on the PR process.
+
+![code_suggestions_assess_impact_stats_1](https://codium.ai/images/pr_agent/code_suggestions_asses_impact_stats_1.png){width=512}
+
+![code_suggestions_assess_impact_stats_2](https://codium.ai/images/pr_agent/code_suggestions_asses_impact_stats_2.png){width=512}
+
+## Suggestion tracking
+
+>`💎 feature. Platforms supported: GitHub, GitLab`
+
+Qodo Merge employs a novel detection system to automatically [identify](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) AI code suggestions that PR authors have accepted and implemented.
+
+Accepted suggestions are also automatically documented in a dedicated wiki page called `.pr_agent_accepted_suggestions`, allowing users to track historical changes, assess the tool's effectiveness, and learn from previously implemented recommendations in the repository.
+An example [result](https://github.com/Codium-ai/pr-agent/wiki/.pr_agent_accepted_suggestions):
+
+[![pr_agent_accepted_suggestions1.png](https://qodo.ai/images/pr_agent/pr_agent_accepted_suggestions1.png){width=768}](https://github.com/Codium-ai/pr-agent/wiki/.pr_agent_accepted_suggestions)
+
+This dedicated wiki page will also serve as a foundation for future AI model improvements, allowing it to learn from historically implemented suggestions and generate more targeted, contextually relevant recommendations.
+
+This feature is controlled by a boolean configuration parameter: `pr_code_suggestions.wiki_page_accepted_suggestions` (default is true).
+
+!!! note "Wiki must be enabled"
+    While the aggregation process is automatic, GitHub repositories require a one-time manual wiki setup.
+
+    To initialize the wiki: navigate to `Wiki`, select `Create the first page`, then click `Save page`.
+
+    ![pr_agent_accepted_suggestions_create_first_page.png](https://qodo.ai/images/pr_agent/pr_agent_accepted_suggestions_create_first_page.png){width=768}
+
+    Once a wiki repo is created, the tool will automatically use this wiki for tracking suggestions.
+
+!!! note "Why a wiki page?"
+    Your code belongs to you, and we respect your privacy. Hence, we won't store any code suggestions in an external database.
+
+    Instead, we leverage a dedicated private page, within your repository wiki, to track suggestions. This approach offers convenient secure suggestion tracking while avoiding pull requests or any noise to the main repository.
+
+## `Extra instructions` and `best practices`
+
+The `improve` tool can be further customized by providing additional instructions and best practices to the AI model.
+
+### Extra instructions
+
+You can use the `extra_instructions` configuration option to give the AI model additional instructions for the `improve` tool.
+Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter.
+
+Examples for possible instructions:
+
+```toml
+[pr_code_suggestions]
+extra_instructions="""\
+(1) Answer in Japanese
+(2) Don't suggest to add try-except block
+(3) Ignore changes in toml files
+...
+"""
+```
+
+Use triple quotes to write multi-line instructions. Use bullet points or numbers to make the instructions more readable.
+
+### Best practices
+
+> `💎 feature. Platforms supported: GitHub, GitLab, Bitbucket`
+
+Another option to give additional guidance to the AI model is by creating a `best_practices.md` file in your repository's root directory.
+This page can contain a list of best practices, coding standards, and guidelines that are specific to your repo/organization.
+
+The AI model will use this `best_practices.md` file as a reference, and in case the PR code violates any of the guidelines, it will create additional suggestions, with a dedicated label: `Organization
+best practice`.
+
+Example for a Python `best_practices.md` content:
+
+```markdown
+## Project best practices
+- Make sure that I/O operations are encapsulated in a try-except block
+- Use the `logging` module for logging instead of `print` statements
+- Use `is` and `is not` to compare with `None`
+- Use `if __name__ == '__main__':` to run the code only when the script is executed
+- Use `with` statement to open files
+...
+```
+
+Tips for writing an effective `best_practices.md` file:
+
+- Write clearly and concisely
+- Include brief code examples when helpful
+- Focus on project-specific guidelines, that will result in relevant suggestions you actually want to get
+- Keep the file relatively short, under 800 lines, since:
+  - AI models may not process effectively very long documents
+  - Long files tend to contain generic guidelines already known to AI
+
+To control the number of best practices suggestions generated by the `improve` tool, give the following configuration:
+
+```toml
+[best_practices]
+num_best_practice_suggestions = 2
+```
+
+#### Local and global best practices
+
+By default, Qodo Merge will look for a local `best_practices.md` in the root of the relevant local repo.
+
+If you want to enable also a global `best_practices.md` file, set first in the global configuration file:
+
+```toml
+[best_practices]
+enable_global_best_practices = true
+```
+
+Then, create a `best_practices.md` file in the root of [global](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#global-configuration-file) configuration repository,  `pr-agent-settings`.
+
+#### Best practices for multiple languages
+
+For a git organization working with multiple programming languages, you can maintain a centralized global `best_practices.md` file containing language-specific guidelines.
+When reviewing pull requests, Qodo Merge automatically identifies the programming language and applies the relevant best practices from this file.
+
+To do this, structure your `best_practices.md` file using the following format:
+
+```
+# [Python]
+...
+# [Java]
+...
+# [JavaScript]
+...
+```
+
+#### Dedicated label for best practices suggestions
+
+Best practice suggestions are labeled as `Organization best practice` by default.
+To customize this label, modify it in your configuration file:
+
+```toml
+[best_practices]
+organization_name = "..."
+```
+
+And the label will be: `{organization_name} best practice`.
+
+#### Example results
+
+![best_practice](https://codium.ai/images/pr_agent/org_best_practice.png){width=512}
+
+### Auto best practices
+
+>`💎 feature. Platforms supported: GitHub.`
+
+`Auto best practices` is a novel Qodo Merge capability that:
+
+1. Identifies recurring patterns from accepted suggestions
+2. **Automatically** generates [best practices page](https://github.com/qodo-ai/pr-agent/wiki/.pr_agent_auto_best_practices) based on what your team consistently values
+3. Applies these learned patterns to future code reviews
+
+This creates an automatic feedback loop where the system continuously learns from your team's choices to provide increasingly relevant suggestions.
+The system maintains two analysis phases:
+
+- Open exploration for new issues
+- Targeted checking against established best practices
+
+Note that when a [custom best practices](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) exist, Qodo Merge will still generate an 'auto best practices' wiki file, though it won't use it in the `improve` tool.
+Learn more about utilizing 'auto best practices' in our [detailed guide](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/).
+
+#### Relevant configurations
+
+```toml
+[auto_best_practices]
+# Disable all auto best practices usage or generation
+enable_auto_best_practices = true  
+
+# Disable usage of auto best practices file in the 'improve' tool
+utilize_auto_best_practices = true 
+
+# Extra instructions to the auto best practices generation prompt
+extra_instructions = ""            
+
+# Max number of patterns to be detected
+max_patterns = 5                   
+```
+
+### Multiple best practices sources
+
+The `improve` tool will combine best practices from all available sources - global configuration, local configuration, and auto-generated files - to provide you with comprehensive recommendations.
+
+
+### Combining 'extra instructions' and 'best practices'
+
+> `💎 feature`
+
+The `extra instructions` configuration is more related to the `improve` tool prompt. It can be used, for example, to avoid specific suggestions ("Don't suggest to add try-except block", "Ignore changes in toml files", ...) or to emphasize specific aspects or formats ("Answer in Japanese", "Give only short suggestions", ...)
+
+In contrast, the `best_practices.md` file is a general guideline for the way code should be written in the repo.
+
+Using a combination of both can help the AI model to provide relevant and tailored suggestions.
+
+## Usage Tips
+
+### Implementing the proposed code suggestions
+
+Each generated suggestion consists of three key elements:
+
+1. A single-line summary of the proposed change
+2. An expandable section containing a comprehensive description of the suggestion
+3. A diff snippet showing the recommended code modification (before and after)
+
+We advise users to apply critical analysis and judgment when implementing the proposed suggestions.
+In addition to mistakes (which may happen, but are rare), sometimes the presented code modification may serve more as an _illustrative example_ than a directly applicable solution.
+In such cases, we recommend prioritizing the suggestion's detailed description, using the diff snippet primarily as a supporting reference.
+
+
+### Chat on code suggestions 
+
+> `💎 feature` Platforms supported: GitHub, GitLab
+
+Qodo Merge implements an orchestrator agent that enables interactive code discussions, listening and responding to comments without requiring explicit tool calls.
+The orchestrator intelligently analyzes your responses to determine if you want to implement a suggestion, ask a question, or request help, then delegates to the appropriate specialized tool.
+
+#### Setup and Activation
+
+Enable interactive code discussions by adding the following to your configuration file (default is `True`):
+
+```toml
+[pr_code_suggestions]
+enable_chat_in_code_suggestions = true
+```
+
+!!! info "Activating Dynamic Responses"
+    To obtain dynamic responses, the following steps are required:
+
+    1. Run the `/improve` command (mostly automatic)
+    2. Tick the `/improve` recommendation checkboxes (_Apply this suggestion_) to have Qodo Merge generate a new inline code suggestion discussion
+    3. The orchestrator agent will then automatically listen and reply to comments within the discussion without requiring additional commands
+
+#### Explore the available interaction patterns:
+
+!!! tip "Tip: Direct the agent with keywords"
+    Use "implement" or "apply" for code generation. Use "explain", "why", or "how" for information and help.
+
+=== "Asking for Details"
+    ![Chat on code suggestions ask](https://codium.ai/images/pr_agent/improve_chat_on_code_suggestions_ask.png){width=512}
+
+=== "Implementing Suggestions"
+    ![Chat on code suggestions implement](https://codium.ai/images/pr_agent/improve_chat_on_code_suggestions_implement.png){width=512}
+
+=== "Providing Additional Help"
+    ![Chat on code suggestions help](https://codium.ai/images/pr_agent/improve_chat_on_code_suggestions_help.png){width=512}
+
+
+### Dual publishing mode
+
+Our recommended approach for presenting code suggestions is through a [table](https://qodo-merge-docs.qodo.ai/tools/improve/#overview) (`--pr_code_suggestions.commitable_code_suggestions=false`).
+This method significantly reduces the PR footprint and allows for quick and easy digestion of multiple suggestions.
+
+We also offer a complementary **dual publishing mode**. When enabled, suggestions exceeding a certain score threshold are not only displayed in the table, but also presented as committable PR comments.
+This mode helps highlight suggestions deemed more critical.
+
+To activate dual publishing mode, use the following setting:
+
+```toml
+[pr_code_suggestions]
+dual_publishing_score_threshold = x
+```
+
+Where x represents the minimum score threshold (>=) for suggestions to be presented as committable PR comments in addition to the table. Default is -1 (disabled).
+
+### Self-review
+
+> `💎 feature` Platforms supported: GitHub, GitLab
+
+If you set in a configuration file:
+
+```toml
+[pr_code_suggestions]
+demand_code_suggestions_self_review = true
+```
+
+The `improve` tool will add a checkbox below the suggestions, prompting user to acknowledge that they have reviewed the suggestions.
+You can set the content of the checkbox text via:
+
+```toml
+[pr_code_suggestions]
+code_suggestions_self_review_text = "... (your text here) ..."
+```
+
+![self_review_1](https://codium.ai/images/pr_agent/self_review_1.png){width=512}
+
+!!! tip "Tip - Reducing visual footprint after self-review 💎"
+
+    The configuration parameter `pr_code_suggestions.fold_suggestions_on_self_review` (default is True)
+    can be used to automatically fold the suggestions after the user clicks the self-review checkbox.
+
+    This reduces the visual footprint of the suggestions, and also indicates to the PR reviewer that the suggestions have been reviewed by the PR author, and don't require further attention.
+
+!!! tip "Tip - Demanding self-review from the PR author 💎"
+
+    By setting:
+    ```toml
+    [pr_code_suggestions]
+    approve_pr_on_self_review = true
+    ```
+    the tool can automatically add an approval when the PR author clicks the self-review checkbox.
+
+
+    - If you set the number of required reviewers for a PR to 2, this effectively means that the PR author must click the self-review checkbox before the PR can be merged (in addition to a human reviewer).
+
+    ![self_review_2](https://codium.ai/images/pr_agent/self_review_2.png){width=512}
+
+    - If you keep the number of required reviewers for a PR to 1 and enable this configuration, this effectively means that the PR author can approve the PR by actively clicking the self-review checkbox.
+
+        To prevent unauthorized approvals, this configuration defaults to false, and cannot be altered through online comments; enabling requires a direct update to the configuration file and a commit to the repository. This ensures that utilizing the feature demands a deliberate documented decision by the repository owner.
+
+### Auto-approval
+
+> `💎 feature. Platforms supported: GitHub, GitLab, Bitbucket`
+
+Under specific conditions, Qodo Merge can auto-approve a PR when a specific comment is invoked, or when the PR meets certain criteria.
+
+**To ensure safety, the auto-approval feature is disabled by default.**
+To enable auto-approval features, you need to actively set one or both of the following options in a pre-defined _configuration file_:
+
+```toml
+[config]
+enable_comment_approval = true # For approval via comments
+enable_auto_approval = true   # For criteria-based auto-approval
+```
+
+!!! note "Notes"
+    - Note that this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository.
+    - Enabling auto-approval must be a deliberate decision by the repository owner.
+
+1\. **Auto-approval by commenting**
+
+To enable auto-approval by commenting, set in the configuration file:
+
+```toml
+[config]
+enable_comment_approval = true
+```
+
+After enabling, by commenting on a PR:
+
+```
+/review auto_approve
+```
+
+Qodo Merge will automatically approve the PR, and add a comment with the approval.
+
+2\. **Auto-approval when the PR meets certain criteria**
+
+To enable auto-approval based on specific criteria, first, you need to enable the top-level flag:
+
+```toml
+[config]
+enable_auto_approval = true
+```
+
+There are two criteria that can be set for auto-approval:
+
+- **Review effort score**
+
+```toml
+[config]
+enable_auto_approval = true
+auto_approve_for_low_review_effort = X # X is a number between 1 to 5
+```
+
+When the [review effort score](https://www.qodo.ai/images/pr_agent/review3.png) is lower or equal to X, the PR will be auto-approved.
+
+___
+
+- **No code suggestions**
+
+```toml
+[config]
+enable_auto_approval = true
+auto_approve_for_no_suggestions = true
+```
+
+When no [code suggestion](https://www.qodo.ai/images/pr_agent/code_suggestions_as_comment_closed.png) were found for the PR, the PR will be auto-approved.
+
+### How many code suggestions are generated?
+
+Qodo Merge uses a dynamic strategy to generate code suggestions based on the size of the pull request (PR). Here's how it works:
+
+#### 1. Chunking large PRs
+
+- Qodo Merge divides large PRs into 'chunks'.
+- Each chunk contains up to `pr_code_suggestions.max_context_tokens` tokens (default: 24,000).
+
+#### 2. Generating suggestions
+
+- For each chunk, Qodo Merge generates up to `pr_code_suggestions.num_code_suggestions_per_chunk` suggestions (default: 4).
+
+This approach has two main benefits:
+
+- Scalability: The number of suggestions scales with the PR size, rather than being fixed.
+- Quality: By processing smaller chunks, the AI can maintain higher quality suggestions, as larger contexts tend to decrease AI performance.
+
+Note: Chunking is primarily relevant for large PRs. For most PRs (up to 600 lines of code), Qodo Merge will be able to process the entire code in a single call.
+
+## Configuration options
+
+??? example "General options"
+
+    <table>
+      <tr>
+        <td><b>extra_instructions</b></td>
+        <td>Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".</td>
+      </tr>
+      <tr>
+        <td><b>commitable_code_suggestions</b></td>
+        <td>If set to true, the tool will display the suggestions as committable code comments. Default is false.</td>
+      </tr>
+      <tr>
+        <td><b>enable_chat_in_code_suggestions</b></td>
+        <td>If set to true, QM bot will interact with comments made on code changes it has proposed. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>dual_publishing_score_threshold</b></td>
+        <td>Minimum score threshold for suggestions to be presented as committable PR comments in addition to the table. Default is -1 (disabled).</td>
+      </tr>
+      <tr>
+        <td><b>focus_only_on_problems</b></td>
+        <td>If set to true, suggestions will focus primarily on identifying and fixing code problems, and less on style considerations like best practices, maintainability, or readability. Default is true.</td> 
+      </tr>
+      <tr>
+        <td><b>persistent_comment</b></td>
+        <td>If set to true, the improve comment will be persistent, meaning that every new improve request will edit the previous one. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>suggestions_score_threshold</b></td>
+        <td> Any suggestion with importance score less than this threshold will be removed. Default is 0. Highly recommend not to set this value above 7-8, since above it may clip relevant suggestions that can be useful. </td>
+      </tr>
+      <tr>
+        <td><b>apply_suggestions_checkbox</b></td>
+        <td> Enable the checkbox to create a committable suggestion. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>enable_more_suggestions_checkbox</b></td>
+        <td> Enable the checkbox to generate more suggestions. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>enable_help_text</b></td>
+        <td>If set to true, the tool will display a help text in the comment. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>enable_chat_text</b></td>
+        <td>If set to true, the tool will display a reference to the PR chat in the comment. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>publish_output_no_suggestions</b></td>
+        <td>If set to true, the tool will publish a comment even if no suggestions were found. Default is true.</td>
+      <tr>
+        <td><b>wiki_page_accepted_suggestions</b></td>
+        <td>If set to true, the tool will automatically track accepted suggestions in a dedicated wiki page called `.pr_agent_accepted_suggestions`. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>allow_thumbs_up_down</b></td>
+        <td>If set to true, all code suggestions will have thumbs up and thumbs down buttons, to encourage users to provide feedback on the suggestions. Default is false. Note that this feature is for statistics tracking. It will not affect future feedback from the AI model.</td>
+      </tr>
+    </table>
+
+??? example "Params for number of suggestions and AI calls"
+
+    <table>
+      <tr>
+        <td><b>auto_extended_mode</b></td>
+        <td>Enable chunking the PR code and running the tool on each chunk. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>num_code_suggestions_per_chunk</b></td>
+        <td>Number of code suggestions provided by the 'improve' tool, per chunk. Default is 3.</td>
+      </tr>
+      <tr>
+        <td><b>max_number_of_calls</b></td>
+        <td>Maximum number of chunks. Default is 3.</td>
+      </tr>
+    </table>
+
+## Understanding AI Code Suggestions
+
+- **AI Limitations:** AI models for code are getting better and better, but they are not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Critical reading and judgment are required. Mistakes of the AI are rare but can happen, and it is usually quite easy for a human to spot them.
+- **Purpose of Suggestions:**
+    - **Self-reflection:** The suggestions aim to enable developers to _self-reflect_ and improve their pull requests. This process can help to identify blind spots, uncover missed edge cases, and enhance code readability and coherency. Even when a specific code suggestion isn't suitable, the underlying issue it highlights often reveals something important that might deserve attention.
+    - **Bug detection:** The suggestions also alert on any _critical bugs_ that may have been identified during the analysis. This provides an additional safety net to catch potential issues before they make it into production. It's perfectly acceptable to implement only the suggestions you find valuable for your specific context.
+- **Hierarchy:** Presenting the suggestions in a structured hierarchical table enables the user to _quickly_ understand them, and to decide which ones are relevant and which are not.
+- **Customization:** To guide the model to suggestions that are more relevant to the specific needs of your project, we recommend using the [`extra_instructions`](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions-and-best-practices) and [`best practices`](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) fields.
+- **Model Selection:** SaaS users can also [choose](https://qodo-merge-docs.qodo.ai/usage-guide/qodo_merge_models/) between different models. For specific programming languages or use cases, some models may perform better than others.
+- **Interactive usage:** The interactive [PR chat](https://qodo-merge-docs.qodo.ai/chrome-extension/) also provides an easy way to get more tailored suggestions and feedback from the AI model.

docs/docs/tools/improve_component.md

@@ -0,0 +1,31 @@
+## 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 usage
+
+Invoke the tool manually by commenting `/improve_component` on any PR:
+
+![improve_component1](https://codium.ai/images/pr_agent/improve_component1.png){width=768}
+
+The tool will generate code suggestions for the selected component (if no component is stated, it will generate code suggestions for the largest component):
+
+![improve_component2](https://codium.ai/images/pr_agent/improve_component2.png){width=768}
+
+!!! note "Notes"
+    - Language that are currently supported by the tool: Python, Java, C++, JavaScript, TypeScript, C#.
+    - This tool can also be triggered interactively by using the [`analyze`](./analyze.md) tool.
+
+## 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

@@ -0,0 +1,25 @@
+# Tools
+
+Here is a list of Qodo Merge 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                                                                            |
+| **[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 |
+| **💎 [Test (`/test`](./test.md))**                                                       | generate tests for a selected component, based on the PR code changes                                                                       |
+| **💎 [Custom Prompt (`/custom_prompt`](./custom_prompt.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                                                                           |
+| **💎 [Implement (`/implement`](./implement.md))**                                        | Generates implementation code from review suggestions                                                                                       |
+| **💎 [Scan Repo Discussions (`/scan_repo_discussions`](./scan_repo_discussions.md))**    | Generates `best_practices.md` file based on previous discussions in the repository                                                          |
+| **💎 [Repo Statistics (`/repo_statistics`](./repo_statistics.md))**                      | Provides repository statistics on time to merge and time to first comment                                                                   |
+
+Note that the tools marked with 💎 are available only for Qodo Merge users.

docs/docs/tools/repo_statistics.md

@@ -0,0 +1,44 @@
+`Platforms supported: GitHub`
+
+## Overview
+
+The `repo_statistics` tool analyzes statistics from merged pull requests over the past 12 months prior to Qodo Merge installation.
+It calculates key metrics that help teams establish a baseline of their PR workflow efficiency.
+
+!!! note "Active repositories are needed"
+    The tool is designed to work with real-life repositories, as it relies on actual discussions to generate meaningful insights.
+    At least 30 merged PRs are required to generate meaningful statistical data.
+
+### Metrics Analyzed
+
+- **Time to merge:** The median and average time it takes for PRs to be merged after opening
+- **Time to first comment:** The median and average time it takes to get the first comment on a PR
+
+
+### Usage
+
+The tool can be invoked manually by commenting on any PR:
+
+```
+/repo_statistics
+```
+
+In response, the bot will comment with the statistical data.
+Note that the scan can take several minutes to complete, since up to 100 PRs are scanned.
+
+!!! info "Automatic trigger"
+    Upon adding the Qodo Merge bot to a repository, the tool will automatically scan the last 365 days of PRs and send them to MixPanel, if enabled.
+
+## Example usage
+
+![repo statistics comment](https://codium.ai/images/pr_agent/repo_statistics_comment.png){width=640}
+
+MixPanel optional presentation:
+
+![repo statistics mixpanel](https://codium.ai/images/pr_agent/repo_statistics_mixpanel.png){width=640}
+
+
+### Configuration options
+
+- Use `/repo_statistics --repo_statistics.days_back=X` to specify the number of days back to scan for discussions. The default is 365 days.
+- Use `/repo_statistics --repo_statistics.minimal_number_of_prs=X` to specify the minimum number of merged PRs needed to generate the statistics. The default is 30 PRs.

docs/docs/tools/review.md

@@ -0,0 +1,170 @@
+## Overview
+
+The `review` tool scans the PR code changes, and generates a list of feedbacks about the PR, aiming to aid the reviewing process.
+<br>
+The tool can be triggered automatically every time a new PR is [opened](../usage-guide/automations_and_usage.md#github-app-automatic-tools-when-a-new-pr-is-opened), or can be invoked manually by commenting on any PR:
+
+```
+/review
+```
+
+Note that the main purpose of the `review` tool is to provide the **PR reviewer** with useful feedbacks and insights. The PR author, in contrast, may prefer to save time and focus on the output of the [improve](./improve.md) tool, which provides actionable code suggestions.
+
+(Read more about the different personas in the PR process and how Qodo Merge aims to assist them in our [blog](https://www.codium.ai/blog/understanding-the-challenges-and-pain-points-of-the-pull-request-cycle/))
+
+## Example usage
+
+### Manual triggering
+
+Invoke the tool manually by commenting `/review` on any PR:
+
+![review comment](https://codium.ai/images/pr_agent/review_comment.png){width=512}
+
+After ~30 seconds, the tool will generate a review for the PR:
+
+![review](https://codium.ai/images/pr_agent/review3.png){width=512}
+
+If you want to edit [configurations](#configuration-options), add the relevant ones to the command:
+
+```
+/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
+```
+
+### Automatic triggering
+
+To run the `review` automatically when a PR is opened, define in a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file):
+
+```
+[github_app]
+pr_commands = [
+    "/review",
+    ...
+]
+
+[pr_reviewer]
+extra_instructions = "..."
+...
+```
+
+- The `pr_commands` lists commands that will be executed automatically when a PR is opened.
+- The `[pr_reviewer]` section contains the configurations for the `review` tool you want to edit (if any).
+
+## Configuration options
+
+!!! example "General options"
+
+    <table>
+      <tr>
+        <td><b>persistent_comment</b></td>
+        <td>If set to true, the review comment will be persistent, meaning that every new review request will edit the previous one. Default is true.</td>
+      </tr>
+      <tr>
+      <td><b>final_update_message</b></td>
+      <td>When set to true, updating a persistent review comment during online commenting will automatically add a short comment with a link to the updated review in the pull request .Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>extra_instructions</b></td>
+        <td>Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".</td>
+      </tr>
+      <tr>
+        <td><b>enable_help_text</b></td>
+        <td>If set to true, the tool will display a help text in the comment. Default is true.</td>
+      </tr>
+    </table>
+
+!!! example "Enable\\disable specific sub-sections"
+
+    <table>
+      <tr>
+        <td><b>require_score_review</b></td>
+        <td>If set to true, the tool will add a section that scores the PR. Default is false.</td>
+      </tr>
+      <tr>
+        <td><b>require_tests_review</b></td>
+        <td>If set to true, the tool will add a section that checks if the PR contains tests. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>require_estimate_effort_to_review</b></td>
+        <td>If set to true, the tool will add a section that estimates the effort needed to review the PR. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>require_can_be_split_review</b></td>
+        <td>If set to true, the tool will add a section that checks if the PR contains several themes, and can be split into smaller PRs. Default is false.</td>
+      </tr>
+      <tr>
+        <td><b>require_security_review</b></td>
+        <td>If set to true, the tool will add a section that checks if the PR contains a possible security or vulnerability issue. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>require_ticket_analysis_review</b></td>
+        <td>If set to true, and the PR contains a GitHub or Jira ticket link, the tool will add a section that checks if the PR in fact fulfilled the ticket requirements. Default is true.</td>
+      </tr>
+    </table>
+
+!!! example "Adding PR labels"
+
+    You can enable\disable the `review` tool to add specific labels to the PR:
+
+    <table>
+      <tr>
+        <td><b>enable_review_labels_security</b></td>
+        <td>If set to true, the tool will publish a 'possible security issue' label if it detects a security issue. Default is true.</td>
+      </tr>
+      <tr>
+        <td><b>enable_review_labels_effort</b></td>
+        <td>If set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is true.</td>
+      </tr>
+    </table>
+
+## Usage Tips
+
+!!! tip "General guidelines"
+
+    The `review` tool provides a collection of configurable feedbacks about a PR.
+    It is recommended to review the [Configuration options](#configuration-options) section, and choose the relevant options for your use case.
+
+    Some of the features that are disabled by default are quite useful, and should be considered for enabling. For example:
+    `require_score_review`, and more.
+
+    On the other hand, if you find one of the enabled features to be irrelevant for your use case, disable it. No default configuration can fit all use cases.
+
+!!! tip "Automation"
+    When you first install Qodo Merge app, the [default mode](../usage-guide/automations_and_usage.md#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, without any additional configurations.
+    Edit this field to enable/disable the tool, or to change the configurations used.
+
+!!! tip "Possible labels from the review tool"
+
+    The `review` tool can auto-generate two specific types of labels for a PR:
+
+    - a `possible security issue` label that detects if a possible [security issue](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) exists in the PR code (`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)
+
+    Both modes are useful, and we recommended to enable them.
+
+!!! tip "Extra instructions"
+
+    Extra instructions are important.
+    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 of 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?
+    - Is the code logic efficient?
+    ...
+    """
+    ```
+    Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
+
+!!! tip  "Code suggestions"
+
+    The `review` tool previously included a legacy feature for providing code suggestions (controlled by `--pr_reviewer.num_code_suggestion`). This functionality has been deprecated and replaced by the [`improve`](./improve.md) tool, which offers higher quality and more actionable code suggestions.

docs/docs/tools/scan_repo_discussions.md

@@ -0,0 +1,44 @@
+`Platforms supported: GitHub`
+
+## Overview
+
+The `scan_repo_discussions` tool analyzes code discussions (meaning review comments over code lines) from merged pull requests over the past 12 months.
+It processes these discussions alongside other PR metadata to identify recurring patterns related to best practices in team feedback and code reviews, generating a comprehensive [`best_practices.md`](https://github.com/qodo-ai/pr-agent/blob/qodo-merge-best-practices_2025-04-16_1018/best_practices.md) document that distills key insights and recommendations.
+
+This file captures repository-specific patterns derived from your team's actual workflow and discussions, rather than more generic best practices.
+It will be utilized by Qodo Merge to provide tailored suggestions for improving code quality in future pull requests.
+
+!!! note "Active repositories are needed"
+    The tool is designed to work with real-life repositories, as it relies on actual discussions to generate meaningful insights.
+    At least 50 merged PRs are required to generate the `best_practices.md` file.
+
+!!! note "Additional customization"
+    Teams are encouraged to further customize and refine these insights to better align with their specific development priorities and contexts.
+    This can be done by editing the `best_practices.md` file directly when the PR is created, or iteratively over time to enhance the 'best practices' suggestions provided by Qodo Merge.
+
+The tool can be invoked manually by commenting on any PR:
+
+```
+/scan_repo_discussions
+```
+
+As a response, the bot will create a new PR that contains an auto-generated `best_practices.md` file.
+Note that the scan can take several minutes to complete, since up to 250 PRs are scanned.
+
+## Example usage
+
+![scan1](https://codium.ai/images/pr_agent/scan_repo_discussions_1.png){width=640}
+
+The PR created by the bot:
+
+![scan1](https://codium.ai/images/pr_agent/scan_repo_discussions_2.png){width=640}
+
+The `best_practices.md` file in the PR:
+
+![scan1](https://codium.ai/images/pr_agent/scan_repo_discussions_3.png){width=640}
+
+### Configuration options
+
+- Use `/scan_repo_discussions --scan_repo_discussions.force_scan=true` to force generating a PR with a new `best_practices.md` file, even if it already exists (by default, the bot will not generate a new file if it already exists).
+- Use `/scan_repo_discussions --scan_repo_discussions.days_back=X` to specify the number of days back to scan for discussions. The default is 365 days.
+- Use `/scan_repo_discussions --scan_repo_discussions.minimal_number_of_prs=X` to specify the minimum number of merged PRs needed to generate the `best_practices.md` file. The default is 50 PRs.

docs/docs/tools/similar_code.md

@@ -0,0 +1,69 @@
+## Overview
+
+The similar code tool retrieves the most similar code components from inside the organization's codebase, or from open-source code.
+
+For example:
+
+`Global Search` for a method called `chat_completion`:
+
+![similar code global](https://codium.ai/images/pr_agent/similar_code_global2.png){width=768}
+
+Qodo Merge will examine the code component and will extract the most relevant keywords to search for similar code:
+
+- `extracted keywords`: the keywords that were extracted from the code by Qodo Merge. the link will open a search page with the extracted keywords, to allow the user to modify the search if needed.
+- `search context`: the context in which the search will be performed, organization's codebase or open-source code (Global).
+- `similar code`: the most similar code components found. the link will open the code component in the relevant file.
+- `relevant repositories`: the open-source repositories in which that are relevant to the searched code component and it's keywords.
+
+Search result link example:
+
+![code search result single](https://codium.ai/images/pr_agent/code_search_result_single.png){width=768}
+
+`Organization Search`:
+
+![similar code org](https://codium.ai/images/pr_agent/similar_code_org.png){width=768}
+
+## How to use
+
+### Manually
+
+To invoke the `similar code` tool manually, comment on the PR:
+
+```
+/find_similar_component COMPONENT_NAME
+```
+
+Where `COMPONENT_NAME` should be the name of a code component in the PR (class, method, function).
+
+If there is a name ambiguity, there are two configurations that will help the tool to find the correct component:
+
+- `--pr_find_similar_component.file`: in case there are several components with the same name, you can specify the relevant file.
+- `--pr_find_similar_component.class_name`: in case there are several methods with the same name in the same file, you can specify the relevant class name.
+
+example:
+
+```
+/find_similar_component COMPONENT_NAME --pr_find_similar_component.file=FILE_NAME
+```
+
+### Automatically (via Analyze table)
+
+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.
+
+![analyze similar](https://codium.ai/images/pr_agent/analyze_similar.png){width=768}
+
+You can search for similar code either within the organization's codebase or globally, which includes open-source repositories. Each result will include the relevant code components along with their associated license details.
+
+![similar code global](https://codium.ai/images/pr_agent/similar_code_global.png){width=768}
+
+## Configuration options
+
+- `search_from_org`: if set to true, the tool will search for similar code in the organization's codebase. Default is false.
+- `number_of_keywords`: number of keywords to use for the search. Default is 5.
+- `number_of_results`: the maximum number of results to present. Default is 5.

docs/docs/tools/similar_issues.md

@@ -0,0 +1,51 @@
+## Overview
+
+The similar issue tool retrieves the most similar issues to the current issue.
+It can be invoked manually by commenting on any PR:
+
+```
+/similar_issue
+```
+
+## Example usage
+
+![similar_issue_original_issue](https://codium.ai/images/pr_agent/similar_issue_original_issue.png){width=768}
+
+![similar_issue_comment](https://codium.ai/images/pr_agent/similar_issue_comment.png){width=768}
+
+![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).
+
+### Selecting a Vector Database
+
+Configure your preferred database by changing the `pr_similar_issue` parameter in `configuration.toml` file.
+
+#### Available Options
+
+Choose from the following Vector Databases:
+
+1. LanceDB
+2. Pinecone
+
+#### Pinecone Configuration
+
+To use Pinecone with the `similar issue` tool, add these credentials to `.secrets.toml` (or set as environment variables):
+
+```
+[pinecone]
+api_key = "..."
+environment = "..."
+```
+
+These parameters can be obtained by registering to [Pinecone](https://app.pinecone.io/?sessionType=signup/).
+
+## How to use
+
+- To invoke the 'similar issue' tool from **CLI**, run:
+`python3 cli.py --issue_url=... similar_issue`
+
+- To invoke the 'similar' issue tool via online usage, [comment](https://github.com/Codium-ai/pr-agent/issues/178#issuecomment-1716934893) on a PR:
+`/similar_issue`
+
+- You can also enable the 'similar issue' tool to run automatically when a new issue is opened, by adding it to the [pr_commands list in the github_app section](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L66)

docs/docs/tools/test.md

@@ -0,0 +1,34 @@
+## Overview
+
+By combining LLM abilities with static code analysis, the `test` tool  generate tests for a selected component, based on the PR code changes.
+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 and choose the relevant component interactively, use the [`analyze`](./analyze.md) tool.
+
+## Example usage
+
+Invoke the tool manually by commenting `/test` on any PR:
+The tool will generate tests for the selected component (if no component is stated, it will generate tests for largest component):
+
+![test1](https://codium.ai/images/pr_agent/test1.png){width=768}
+
+(Example taken from [here](https://github.com/Codium-ai/pr-agent/pull/598#issuecomment-1913679429)):
+
+!!! note "Notes"
+    - The following languages are currently supported: Python, Java, C++, JavaScript, TypeScript, C#.
+    - This tool can also be triggered interactively by using the [`analyze`](./analyze.md) tool.
+
+## Configuration options
+
+- `num_tests`: number of tests to generate. Default is 3.
+- `testing_framework`: the testing framework to use. If not set, for Python it will use `pytest`, for Java it will use `JUnit`, for C++ it will use `Catch2`, and for JavaScript and TypeScript it will use `jest`.
+- `avoid_mocks`: if set to true, the tool will try to avoid using mocks in the generated tests. Note that even if this option is set to true, the tool might still use mocks if it cannot generate a test without them. Default is true.
+- `extra_instructions`: Optional extra instructions to the tool. For example: "use the following mock injection scheme: ...".
+- `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.
+- `enable_help_text`: if set to true, the tool will add a help text to the PR comment. Default is true.

docs/docs/tools/update_changelog.md

@@ -0,0 +1,23 @@
+## Overview
+
+The `update_changelog` tool automatically updates the CHANGELOG.md file with the PR changes.
+It can be invoked manually by commenting on any PR:
+
+```
+/update_changelog
+```
+
+## Example usage
+
+![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
+
+Under the section `pr_update_changelog`, the [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L50) contains options to customize the 'update changelog' tool:
+
+- `push_changelog_changes`: whether to push the changes to CHANGELOG.md, or just publish them as a comment. Default is false (publish as comment).
+- `extra_instructions`: Optional extra instructions to the tool. For example: "Use the following structure: ..."
+- `add_pr_link`: whether the model should try to add a link to the PR in the changelog. Default is true.
+- `skip_ci_on_push`: whether the commit message (when `push_changelog_changes` is true) will include the term "[skip ci]", preventing CI tests to be triggered on the changelog commit. Default is true.

docs/docs/usage-guide/EXAMPLE_BEST_PRACTICE.md

@@ -0,0 +1,190 @@
+## Recommend Python Best Practices
+
+This document outlines a series of recommended best practices for Python development. These guidelines aim to improve code quality, maintainability, and readability.
+
+### Imports
+
+Use  `import`  statements for packages and modules only, not for individual types, classes, or functions.
+
+#### Definition
+
+Reusability mechanism for sharing code from one module to another.
+
+#### Decision
+
+- Use  `import x`  for importing packages and modules.
+- Use  `from x import y`  where  `x`  is the package prefix and  `y`  is the module name with no prefix.
+- Use  `from x import y as z`  in any of the following circumstances:
+  - Two modules named  `y`  are to be imported.
+  - `y`  conflicts with a top-level name defined in the current module.
+  - `y`  conflicts with a common parameter name that is part of the public API (e.g.,  `features`).
+  - `y`  is an inconveniently long name, or too generic in the context of your code
+- Use  `import y as z`  only when  `z`  is a standard abbreviation (e.g.,  `import numpy as np`).
+
+For example the module  `sound.effects.echo`  may be imported as follows:
+
+```
+from sound.effects import echo
+...
+echo.EchoFilter(input, output, delay=0.7, atten=4)
+
+```
+
+Do not use relative names in imports. Even if the module is in the same package, use the full package name. This helps prevent unintentionally importing a package twice.
+
+##### Exemptions
+
+Exemptions from this rule:
+
+- Symbols from the following modules are used to support static analysis and type checking:
+  - [`typing`  module](https://google.github.io/styleguide/pyguide.html#typing-imports)
+  - [`collections.abc`  module](https://google.github.io/styleguide/pyguide.html#typing-imports)
+  - [`typing_extensions`  module](https://github.com/python/typing_extensions/blob/main/README.md)
+- Redirects from the  [six.moves module](https://six.readthedocs.io/#module-six.moves).
+
+### Packages
+
+Import each module using the full pathname location of the module.
+
+#### Decision
+
+All new code should import each module by its full package name.
+
+Imports should be as follows:
+
+```
+Yes:
+  # Reference absl.flags in code with the complete name (verbose).
+  import absl.flags
+  from doctor.who import jodie
+
+  _FOO = absl.flags.DEFINE_string(...)
+
+```
+
+```
+Yes:
+  # Reference flags in code with just the module name (common).
+  from absl import flags
+  from doctor.who import jodie
+
+  _FOO = flags.DEFINE_string(...)
+
+```
+
+_(assume this file lives in  `doctor/who/`  where  `jodie.py`  also exists)_
+
+```
+No:
+  # Unclear what module the author wanted and what will be imported.  The actual
+  # import behavior depends on external factors controlling sys.path.
+  # Which possible jodie module did the author intend to import?
+  import jodie
+
+```
+
+The directory the main binary is located in should not be assumed to be in  `sys.path`  despite that happening in some environments. This being the case, code should assume that  `import jodie`  refers to a third-party or top-level package named  `jodie`, not a local  `jodie.py`.
+
+### Default Iterators and Operators
+
+Use default iterators and operators for types that support them, like lists, dictionaries, and files.
+
+#### Definition
+
+Container types, like dictionaries and lists, define default iterators and membership test operators (“in” and “not in”).
+
+#### Decision
+
+Use default iterators and operators for types that support them, like lists, dictionaries, and files. The built-in types define iterator methods, too. Prefer these methods to methods that return lists, except that you should not mutate a container while iterating over it.
+
+```
+Yes:  for key in adict: ...
+      if obj in alist: ...
+      for line in afile: ...
+      for k, v in adict.items(): ...
+```
+
+```
+No:   for key in adict.keys(): ...
+      for line in afile.readlines(): ...
+```
+
+### Lambda Functions
+
+Okay for one-liners. Prefer generator expressions over  `map()`  or  `filter()`  with a  `lambda`.
+
+#### Decision
+
+Lambdas are allowed. If the code inside the lambda function spans multiple lines or is longer than 60-80 chars, it might be better to define it as a regular  [nested function](https://google.github.io/styleguide/pyguide.html#lexical-scoping).
+
+For common operations like multiplication, use the functions from the  `operator`  module instead of lambda functions. For example, prefer  `operator.mul`  to  `lambda x, y: x * y`.
+
+### Default Argument Values
+
+Okay in most cases.
+
+#### Definition
+
+You can specify values for variables at the end of a function’s parameter list, e.g.,  `def foo(a, b=0):`. If  `foo`  is called with only one argument,  `b`  is set to 0. If it is called with two arguments,  `b`  has the value of the second argument.
+
+#### Decision
+
+Okay to use with the following caveat:
+
+Do not use mutable objects as default values in the function or method definition.
+
+```
+Yes: def foo(a, b=None):
+         if b is None:
+             b = []
+Yes: def foo(a, b: Sequence | None = None):
+         if b is None:
+             b = []
+Yes: def foo(a, b: Sequence = ()):  # Empty tuple OK since tuples are immutable.
+         ...
+```
+
+```
+from absl import flags
+_FOO = flags.DEFINE_string(...)
+
+No:  def foo(a, b=[]):
+         ...
+No:  def foo(a, b=time.time()):  # Is `b` supposed to represent when this module was loaded?
+         ...
+No:  def foo(a, b=_FOO.value):  # sys.argv has not yet been parsed...
+         ...
+No:  def foo(a, b: Mapping = {}):  # Could still get passed to unchecked code.
+         ...
+```
+
+### True/False Evaluations
+
+Use the “implicit” false if possible, e.g.,  `if foo:`  rather than  `if foo != []:`
+
+### Lexical Scoping
+
+Okay to use.
+
+An example of the use of this feature is:
+
+```
+def get_adder(summand1: float) -> Callable[[float], float]:
+    """Returns a function that adds numbers to a given number."""
+    def adder(summand2: float) -> float:
+        return summand1 + summand2
+
+    return adder
+```
+
+#### Decision
+
+Okay to use.
+
+### Threading
+
+Do not rely on the atomicity of built-in types.
+
+While Python’s built-in data types such as dictionaries appear to have atomic operations, there are corner cases where they aren’t atomic (e.g. if  `__hash__`  or  `__eq__`  are implemented as Python methods) and their atomicity should not be relied upon. Neither should you rely on atomic variable assignment (since this in turn depends on dictionaries).
+
+Use the  `queue`  module’s  `Queue`  data type as the preferred way to communicate data between threads. Otherwise, use the  `threading`  module and its locking primitives. Prefer condition variables and  `threading.Condition`  instead of using lower-level locks.

docs/docs/usage-guide/additional_configurations.md

@@ -0,0 +1,252 @@
+## Show possible configurations
+
+The possible configurations of Qodo Merge are stored in [here](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml){:target="_blank"}.
+In the [tools](https://qodo-merge-docs.qodo.ai/tools/) page you can find explanations on how to use these configurations for each tool.
+
+To print all the available configurations as a comment on your PR, you can use the following command:
+
+```
+/config
+```
+
+![possible_config1](https://codium.ai/images/pr_agent/possible_config1.png){width=512}
+
+To view the **actual** configurations used for a specific tool, after all the user settings are applied, you can add for each tool a `--config.output_relevant_configurations=true` suffix.
+For example:
+
+```
+/improve --config.output_relevant_configurations=true
+```
+
+Will output an additional field showing the actual configurations used for the `improve` tool.
+
+![possible_config2](https://codium.ai/images/pr_agent/possible_config2.png){width=512}
+
+## Ignoring files from analysis
+
+In some cases, you may want to exclude specific files or directories from the analysis performed by Qodo Merge. This can be useful, for example, when you have files that are generated automatically or files that shouldn't be reviewed, like vendor code.
+
+You can ignore files or folders using the following methods:
+
+- `IGNORE.GLOB`
+- `IGNORE.REGEX`
+
+which you can edit to ignore files or folders based on glob or regex patterns.
+
+### Example usage
+
+Let's look at an example where we want to ignore all files with `.py` extension from the analysis.
+
+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 using `glob` pattern, set in a configuration file:
+
+```
+[ignore]
+glob = ['*.py']
+```
+
+And to ignore Python files in all PRs using `regex` pattern, set in a configuration file:
+
+```
+[regex]
+regex = ['.*\.py$']
+```
+
+## Extra instructions
+
+All Qodo Merge tools have a parameter called `extra_instructions`, that enables to add free-text extra instructions. Example usage:
+
+```
+/update_changelog --pr_update_changelog.extra_instructions="Make sure to update also the version ..."
+```
+
+## Language Settings
+
+The default response language for Qodo Merge is **U.S. English**. However, some development teams may prefer to display information in a different language. For example, your team's workflow might improve if PR descriptions and code suggestions are set to your country's native language.  
+
+To configure this, set the `response_language` parameter in the configuration file. This will prompt the model to respond in the specified language. Use a **standard locale code** based on [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166) (country codes) and [ISO 639](https://en.wikipedia.org/wiki/ISO_639) (language codes) to define a language-country pair. See this [comprehensive list of locale codes](https://simplelocalize.io/data/locales/).  
+
+Example:
+
+```toml
+[config]
+response_language = "it-IT"
+```
+
+This will set the response language globally for all the commands to Italian.
+
+> **Important:** Note that only dynamic text generated by the AI model is translated to the configured language. Static text such as labels and table headers that are not part of the AI models response will remain in US English. In addition, the model you are using must have good support for the specified language.
+
+[//]: # (## 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 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 two possible solutions:)
+
+[//]: # (1) [Use a model](https://qodo-merge-docs.qodo.ai/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://qodo-merge-docs.qodo.ai/tools/improve/) (`/improve --extended`),)
+
+[//]: # (which divides the PR into 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))
+
+## Patch Extra Lines
+
+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...
+ code line that already existed in the file...
+ code line that already existed in the file....
+-code line that was removed in the PR
++new code line added in the PR
+ code line that already existed in the file...
+ code line that already existed in the file...
+ code line that already existed in the file...
+```
+
+Qodo Merge will try to increase the number of lines of context, via the parameter:
+
+```
+[config]
+patch_extra_lines_before=3
+patch_extra_lines_after=1
+```
+
+Increasing this number provides more context to the model, but will also increase the token budget, and may overwhelm the model with too much information, unrelated to the actual PR code changes.
+
+If the PR is too large (see [PR Compression strategy](https://github.com/Codium-ai/pr-agent/blob/main/PR_COMPRESSION.md)), Qodo Merge may automatically set this number to 0, and will use the original git patch.
+
+## Log Level
+
+Qodo Merge allows you to control the verbosity of logging by using the `log_level` configuration parameter. This is particularly useful for troubleshooting and debugging issues with your PR workflows.
+
+```
+[config]
+log_level = "DEBUG"  # Options: "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"
+```
+
+The default log level is "DEBUG", which provides detailed output of all operations. If you prefer less verbose logs, you can set higher log levels like "INFO" or "WARNING".
+
+## Integrating with Logging Observability Platforms
+
+Various logging observability tools can be used out-of-the box when using the default LiteLLM AI Handler. Simply configure the LiteLLM callback settings in `configuration.toml` and set environment variables according to the LiteLLM [documentation](https://docs.litellm.ai/docs/).
+
+For example, to use [LangSmith](https://www.langchain.com/langsmith) you can add the following to your `configuration.toml` file:
+
+```
+[litellm]
+enable_callbacks = true
+success_callback = ["langsmith"]
+failure_callback = ["langsmith"]
+service_callback = []
+```
+
+Then set the following environment variables:
+
+```
+LANGSMITH_API_KEY=<api_key>
+LANGSMITH_PROJECT=<project>
+LANGSMITH_BASE_URL=<url>
+```
+
+## Ignoring automatic commands in PRs
+
+Qodo Merge allows you to automatically ignore certain PRs based on various criteria:
+
+- PRs with specific titles (using regex matching)
+- PRs between specific branches (using regex matching)
+- PRs from specific repositories (using regex matching)
+- PRs not from specific folders
+- PRs containing specific labels
+- PRs opened by specific users
+
+### Ignoring PRs with specific titles
+
+To ignore PRs with a specific title such as "[Bump]: ...", you can add the following to your `configuration.toml` file:
+
+```toml
+[config]
+ignore_pr_title = ["\\[Bump\\]"]
+```
+
+Where the `ignore_pr_title` is a list of regex patterns to match the PR title you want to ignore. Default is `ignore_pr_title = ["^\\[Auto\\]", "^Auto"]`.
+
+### Ignoring PRs between specific branches
+
+To ignore PRs from specific source or target branches, you can add the following to your `configuration.toml` file:
+
+```toml
+[config]
+ignore_pr_source_branches = ['develop', 'main', 'master', 'stage']
+ignore_pr_target_branches = ["qa"]
+```
+
+Where the `ignore_pr_source_branches` and `ignore_pr_target_branches` are lists of regex patterns to match the source and target branches you want to ignore.
+They are not mutually exclusive, you can use them together or separately.
+
+### Ignoring PRs from specific repositories
+
+To ignore PRs from specific repositories, you can add the following to your `configuration.toml` file:
+
+```toml
+[config]
+ignore_repositories = ["my-org/my-repo1", "my-org/my-repo2"]
+```
+
+Where the `ignore_repositories` is a list of regex patterns to match the repositories you want to ignore. This is useful when you have multiple repositories and want to exclude certain ones from analysis.
+
+
+### Ignoring PRs not from specific folders
+
+To allow only specific folders (often needed in large monorepos), set:
+
+```
+[config]
+allow_only_specific_folders=['folder1','folder2']
+```
+
+For the configuration above, automatic feedback will only be triggered when the PR changes include files where 'folder1' or 'folder2' is in the file path
+
+### Ignoring PRs containing specific labels
+
+To ignore PRs containing specific labels, you can add the following to your `configuration.toml` file:
+
+```
+[config]
+ignore_pr_labels = ["do-not-merge"]
+```
+
+Where the `ignore_pr_labels` is a list of labels that when present in the PR, the PR will be ignored.
+
+### Ignoring PRs from specific users
+
+Qodo Merge tries to automatically identify and ignore pull requests created by bots using:
+
+- GitHub's native bot detection system
+- Name-based pattern matching
+
+While this detection is robust, it may not catch all cases, particularly when:
+
+- Bots are registered as regular user accounts
+- Bot names don't match common patterns
+
+To supplement the automatic bot detection, you can manually specify users to ignore. Add the following to your `configuration.toml` file to ignore PRs from specific users:
+
+```
+[config]
+ignore_pr_authors = ["my-special-bot-user", ...]
+```
+
+Where the `ignore_pr_authors` is a list of usernames that you want to ignore.
+
+!!! note
+    There is one specific case where bots will receive an automatic response - when they generated a PR with a _failed test_. In that case, the [`ci_feedback`](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/) tool will be invoked.

docs/docs/usage-guide/automations_and_usage.md

@@ -0,0 +1,314 @@
+## Local repo (CLI)
+
+When running from your locally cloned Qodo Merge repo (CLI), your local configuration file will be used.
+Examples of invoking the different tools via the CLI:
+
+- **Review**:       `python -m pr_agent.cli --pr_url=<pr_url>  review`
+- **Describe**:     `python -m pr_agent.cli --pr_url=<pr_url>  describe`
+- **Improve**:      `python -m pr_agent.cli --pr_url=<pr_url>  improve`
+- **Ask**:          `python -m pr_agent.cli --pr_url=<pr_url>  ask "Write me a poem about this PR"`
+- **Update Changelog**:      `python -m pr_agent.cli --pr_url=<pr_url>  update_changelog`
+
+`<pr_url>` is the url of the relevant PR (for example: [#50](https://github.com/Codium-ai/pr-agent/pull/50)).
+
+**Notes:**
+
+1. in addition to editing your local configuration file, you can also change any configuration value by adding it to the command line:
+
+```
+python -m pr_agent.cli --pr_url=<pr_url>  /review --pr_reviewer.extra_instructions="focus on the file: ..."
+```
+
+2. You can print results locally, without publishing them, by setting in `configuration.toml`:
+
+```
+[config]
+publish_output=false
+verbosity_level=2
+```
+
+This is useful for debugging or experimenting with different tools.
+
+3. **git provider**: The [git_provider](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L5) field in a configuration file determines the GIT provider that will be used by Qodo Merge. Currently, the following providers are supported:
+`github` **(default)**, `gitlab`, `bitbucket`, `azure`, `codecommit`, `local`, and `gerrit`.
+
+### CLI Health Check
+
+To verify that Qodo Merge has been configured correctly, you can run this health check command from the repository root:
+
+```bash
+python -m tests.health_test.main
+```
+
+If the health check passes, you will see the following output:
+
+```
+========
+Health test passed successfully
+========
+```
+
+At the end of the run.
+
+Before running the health check, ensure you have:
+
+- Configured your [LLM provider](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/)
+- Added a valid GitHub token to your configuration file
+
+## Online usage
+
+Online usage means invoking Qodo Merge tools by [comments](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901) on a PR.
+Commands for invoking the different tools via comments:
+
+- **Review**:       `/review`
+- **Describe**:     `/describe`
+- **Improve**:      `/improve`  (or `/improve_code` for bitbucket, since `/improve` is sometimes reserved)
+- **Ask**:          `/ask "..."`
+- **Update Changelog**:      `/update_changelog`
+
+To edit a specific configuration value, just add `--config_path=<value>` to any command.
+For example, if you want to edit the `review` tool configurations, you can run:
+
+```
+/review --pr_reviewer.extra_instructions="..." --pr_reviewer.require_score_review=false
+```
+
+Any configuration value in [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) file can be similarly edited. Comment `/config` to see the list of available configurations.
+
+## Qodo Merge Automatic Feedback
+
+### Disabling all automatic feedback
+
+To easily disable all automatic feedback from Qodo Merge (GitHub App, GitLab Webhook, BitBucket App, Azure DevOps Webhook), set in a configuration file:
+
+```toml
+[config]
+disable_auto_feedback = true
+```
+
+When this parameter is set to `true`, Qodo Merge will not run any automatic tools (like `describe`, `review`, `improve`) when a new PR is opened, or when new code is pushed to an open PR.
+
+### GitHub App
+
+!!! note "Configurations for Qodo Merge"
+    Qodo Merge for GitHub is an App, hosted by Qodo. So all the instructions below are relevant also for Qodo Merge 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#L220) section defines GitHub app specific configurations.
+
+The configuration parameter `pr_commands` defines the list of tools that will be **run automatically** when a new PR is opened:
+
+```toml
+[github_app]
+pr_commands = [
+    "/describe",
+    "/review",
+    "/improve",
+]
+```
+
+This means that when a new PR is opened/reopened or marked as ready for review, Qodo Merge will run the `describe`, `review` and `improve` tools.  
+
+**Draft PRs:** 
+
+By default, draft PRs are not considered for automatic tools, but you can change this by setting the `feedback_on_draft_pr` parameter to `true` in the configuration file.
+
+```toml
+[github_app]
+feedback_on_draft_pr = true
+```
+
+**Changing default tool parameters:**
+
+You can override the default tool parameters by using one the three options for a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/): **wiki**, **local**, or **global**.
+For example, if your configuration file contains:
+
+```toml
+[pr_description]
+generate_ai_title = true
+```
+
+Every time you run the `describe` tool (including automatic runs) the PR title will be generated by the AI.
+
+
+**Parameters for automated runs:**
+
+You can customize configurations specifically for automated runs by using the `--config_path=<value>` parameter.
+For instance, to modify the `review` tool settings only for newly opened PRs, use:
+
+```toml
+[github_app]
+pr_commands = [
+    "/describe",
+    "/review --pr_reviewer.extra_instructions='focus on the file: ...'",
+    "/improve",
+]
+```
+
+#### GitHub app automatic tools for push actions (commits to an open PR)
+
+In addition to running automatic tools when a PR is opened, the GitHub app can also respond to new code that is pushed to an open PR.
+
+The configuration toggle `handle_push_trigger` can be used to enable this feature.
+The configuration parameter `push_commands` defines the list of tools that will be **run automatically** when new code is pushed to the PR.
+
+```toml
+[github_app]
+handle_push_trigger = true
+push_commands = [
+    "/describe",
+    "/review",
+]
+```
+
+This means that when new code is pushed to the PR, the Qodo Merge will run the `describe` and `review` tools, with the specified parameters.
+
+### GitHub Action
+
+`GitHub Action` is a different way to trigger Qodo Merge 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
+      env:
+        OPENAI_KEY: ${{ secrets.OPENAI_KEY }} # Make sure to add your OpenAI key to your repo secrets
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Make sure to add your GitHub token to your repo secrets
+        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.pr_actions: '["opened", "reopened", "ready_for_review", "review_requested"]'
+```
+
+`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.
+
+`github_action_config.pr_actions` is used to configure which `pull_requests` events will trigger the enabled auto flags
+If not set, the default configuration is `["opened", "reopened", "ready_for_review", "review_requested"]`
+
+`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/qodo-ai/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml).
+
+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://qodo-merge-docs.qodo.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:
+
+```toml
+[pr_description]
+publish_labels = false
+```
+
+to prevent Qodo Merge 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 MR is opened, you can set the `pr_commands` parameter in the configuration file, similar to the GitHub App:
+
+```toml
+[gitlab]
+pr_commands = [
+    "/describe",
+    "/review",
+    "/improve",
+]
+```
+
+the GitLab webhook can also respond to new code that is pushed to an open MR.
+The configuration toggle `handle_push_trigger` can be used to enable this feature.
+The configuration parameter `push_commands` defines the list of tools that will be **run automatically** when new code is pushed to the MR.
+
+```toml
+[gitlab]
+handle_push_trigger = true
+push_commands = [
+    "/describe",
+    "/review",
+]
+```
+
+Note that to use the 'handle_push_trigger' feature, you need to give the gitlab webhook also the "Push events" scope.
+
+### BitBucket App
+
+Similar to GitHub app, when running Qodo Merge from BitBucket App, the default [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) will be initially loaded.
+
+By uploading a local `.pr_agent.toml` file to the root of the repo's default branch, you can edit and customize any configuration parameter. Note that you need to upload `.pr_agent.toml` prior to creating a PR, in order for the configuration to take effect.
+
+For example, if your local `.pr_agent.toml` file contains:
+
+```toml
+[pr_reviewer]
+extra_instructions = "Answer in japanese"
+```
+
+Each time you invoke a `/review` tool, it will use the extra instructions you set in the local configuration file.
+
+Note that among other limitations, BitBucket provides relatively low rate-limits for applications (up to 1000 requests per hour), and does not provide an API to track the actual rate-limit usage.
+If you experience a lack of responses from Qodo Merge, you might want to set: `bitbucket_app.avoid_full_files=true` in your configuration file.
+This will prevent Qodo Merge from acquiring the full file content, and will only use the diff content. This will reduce the number of requests made to BitBucket, at the cost of small decrease in accuracy, as dynamic context will not be applicable.
+
+#### 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:
+Specifically, set the following values:
+
+```toml
+[bitbucket_app]
+pr_commands = [
+    "/review",
+    "/improve --pr_code_suggestions.commitable_code_suggestions=true --pr_code_suggestions.suggestions_score_threshold=7",
+]
+```
+
+Note that we set specifically for bitbucket, we recommend using: `--pr_code_suggestions.suggestions_score_threshold=7` and that is the default value we set for bitbucket.
+Since this platform only supports inline code suggestions, we want to limit the number of suggestions, and only present a limited number.
+
+To enable BitBucket app to respond to each **push** to the PR, set (for example):
+
+```toml
+[bitbucket_app]
+handle_push_trigger = true
+push_commands = [
+    "/describe",
+    "/review",
+]
+```
+
+### Azure DevOps provider
+
+To use Azure DevOps provider use the following settings in configuration.toml:
+
+```toml
+[config]
+git_provider="azure"
+```
+
+Azure DevOps provider supports [PAT token](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=Windows) or [DefaultAzureCredential](https://learn.microsoft.com/en-us/azure/developer/python/sdk/authentication-overview#authentication-in-server-environments) authentication.
+PAT is faster to create, but has build in expiration date, and will use the user identity for API calls.
+Using DefaultAzureCredential you can use managed identity or Service principle, which are more secure and will create separate ADO user identity (via AAD) to the agent.
+
+If PAT was chosen, you can assign the value in .secrets.toml.
+If DefaultAzureCredential was chosen, you can assigned the additional env vars like AZURE_CLIENT_SECRET directly,
+or use managed identity/az cli (for local development) without any additional configuration.
+in any case, 'org' value must be assigned in .secrets.toml:
+
+```
+[azure_devops]
+org = "https://dev.azure.com/YOUR_ORGANIZATION/"
+# pat = "YOUR_PAT_TOKEN" needed only if using PAT for authentication
+```
+
+#### Azure DevOps 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:
+
+```toml
+[azure_devops_server]
+pr_commands = [
+    "/describe",
+    "/review",
+    "/improve",
+]
+```

docs/docs/usage-guide/changing_a_model.md

@@ -0,0 +1,356 @@
+## Changing a model in PR-Agent
+
+See [here](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/algo/__init__.py) for a list of available models.
+To use a different model than the default (o4-mini), you need to edit in the [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L2) the fields:
+
+```toml
+[config]
+model = "..."
+fallback_models = ["..."]
+```
+
+For models and environments not from OpenAI, you might need to provide additional keys and other parameters.
+You can give parameters via a configuration file, or from environment variables.
+
+!!! note "Model-specific environment variables"
+    See [litellm documentation](https://litellm.vercel.app/docs/proxy/quick_start#supported-llms) for the environment variables needed per model, as they may vary and change over time. Our documentation per-model may not always be up-to-date with the latest changes.
+    Failing to set the needed keys of a specific model will usually result in litellm not identifying the model type, and failing to utilize it.
+
+### OpenAI like API
+To use an OpenAI like API, set the following in your `.secrets.toml` file:
+
+```toml
+[openai]
+api_base = "https://api.openai.com/v1"
+api_key = "sk-..."
+```
+
+or use the environment variables (make sure to use double underscores `__`):
+
+```bash
+OPENAI__API_BASE=https://api.openai.com/v1
+OPENAI__KEY=sk-...
+```
+
+
+### Azure
+
+To use Azure, set in your `.secrets.toml` (working from CLI), or in the GitHub `Settings > Secrets and variables` (working from GitHub App or GitHub Action):
+
+```toml
+[openai]
+key = "" # your azure api key
+api_type = "azure"
+api_version = '2023-05-15'  # Check Azure documentation for the current API version
+api_base = ""  # The base URL for your Azure OpenAI resource. e.g. "https://<your resource name>.openai.azure.com"
+deployment_id = ""  # The deployment name you chose when you deployed the engine
+```
+
+and set in your configuration file:
+
+```toml
+[config]
+model="" # the OpenAI model you've deployed on Azure (e.g. gpt-4o)
+fallback_models=["..."]
+```
+
+To use Azure AD (Entra id) based authentication set in your `.secrets.toml` (working from CLI), or in the GitHub `Settings > Secrets and variables` (working from GitHub App or GitHub Action):
+
+```toml
+[azure_ad]
+client_id = ""  # Your Azure AD application client ID
+client_secret = ""  # Your Azure AD application client secret
+tenant_id = ""  # Your Azure AD tenant ID
+api_base = ""  # Your Azure OpenAI service base URL (e.g., https://openai.xyz.com/)
+```
+
+Passing custom headers to the underlying LLM Model API can be done by setting extra_headers parameter to litellm.
+
+```toml
+[litellm]
+extra_headers='{"projectId": "<authorized projectId >", ...}') #The value of this setting should be a JSON string representing the desired headers, a ValueError is thrown otherwise.
+```
+
+This enables users to pass authorization tokens or API keys, when routing requests through an API management gateway.
+
+### Ollama
+
+You can run models locally through either [VLLM](https://docs.litellm.ai/docs/providers/vllm) or [Ollama](https://docs.litellm.ai/docs/providers/ollama)
+
+E.g. to use a new model locally via Ollama, set in `.secrets.toml` or in a configuration file:
+
+```toml
+[config]
+model = "ollama/qwen2.5-coder:32b"
+fallback_models=["ollama/qwen2.5-coder:32b"]
+custom_model_max_tokens=128000 # set the maximal input tokens for the model
+duplicate_examples=true # will duplicate the examples in the prompt, to help the model to generate structured output
+
+[ollama]
+api_base = "http://localhost:11434" # or whatever port you're running Ollama on
+```
+
+By default, Ollama uses a context window size of 2048 tokens. In most cases this is not enough to cover pr-agent promt and pull-request diff. Context window size can be overridden with the `OLLAMA_CONTEXT_LENGTH` environment variable. For example, to set the default context length to 8K, use: `OLLAMA_CONTEXT_LENGTH=8192 ollama serve`. More information you can find on the [official ollama faq](https://github.com/ollama/ollama/blob/main/docs/faq.md#how-can-i-specify-the-context-window-size).
+
+Please note that the `custom_model_max_tokens` setting should be configured in accordance with the `OLLAMA_CONTEXT_LENGTH`. Failure to do so may result in unexpected model output.
+
+!!! note "Local models vs commercial models"
+    Qodo Merge is compatible with almost any AI model, but analyzing complex code repositories and pull requests requires a model specifically optimized for code analysis.
+
+    Commercial models such as GPT-4, Claude Sonnet, and Gemini have demonstrated robust capabilities in generating structured output for code analysis tasks with large input. In contrast, most open-source models currently available (as of January 2025) face challenges with these complex tasks.
+
+    Based on our testing, local open-source models are suitable for experimentation and learning purposes (mainly for the `ask` command), but they are not suitable for production-level code analysis tasks.
+    
+    Hence, for production workflows and real-world usage, we recommend using commercial models.
+
+### Hugging Face
+
+To use a new model with Hugging Face Inference Endpoints, for example, set:
+
+```toml
+[config] # in configuration.toml
+model = "huggingface/meta-llama/Llama-2-7b-chat-hf"
+fallback_models=["huggingface/meta-llama/Llama-2-7b-chat-hf"]
+custom_model_max_tokens=... # set the maximal input tokens for the model
+
+[huggingface] # in .secrets.toml
+key = ... # your Hugging Face api key
+api_base = ... # the base url for your Hugging Face inference endpoint
+```
+
+(you can obtain a Llama2 key from [here](https://replicate.com/replicate/llama-2-70b-chat/api))
+
+### Replicate
+
+To use Llama2 model with Replicate, for example, set:
+
+```toml
+[config] # in configuration.toml
+model = "replicate/llama-2-70b-chat:2c1608e18606fad2812020dc541930f2d0495ce32eee50074220b87300bc16e1"
+fallback_models=["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 instructions on how to set keys for other models.
+
+### Groq
+
+To use Llama3 model with Groq, for example, set:
+
+```toml
+[config] # in configuration.toml
+model = "llama3-70b-8192"
+fallback_models = ["groq/llama3-70b-8192"]
+[groq] # in .secrets.toml
+key = ... # your Groq api key
+```
+
+(you can obtain a Groq key from [here](https://console.groq.com/keys))
+
+### xAI
+
+To use xAI's models with PR-Agent, set:
+
+```toml
+[config] # in configuration.toml
+model = "xai/grok-2-latest"
+fallback_models = ["xai/grok-2-latest"] # or any other model as fallback
+
+[xai] # in .secrets.toml
+key = "..." # your xAI API key
+```
+
+You can obtain an xAI API key from [xAI's console](https://console.x.ai/) by creating an account and navigating to the developer settings page.
+
+### Vertex AI
+
+To use Google's Vertex AI platform and its associated models (chat-bison/codechat-bison) set:
+
+```toml
+[config] # in configuration.toml
+model = "vertex_ai/codechat-bison"
+fallback_models="vertex_ai/codechat-bison"
+
+[vertexai] # in .secrets.toml
+vertex_project = "my-google-cloud-project"
+vertex_location = ""
+```
+
+Your [application default credentials](https://cloud.google.com/docs/authentication/application-default-credentials) will be used for authentication so there is no need to set explicit credentials in most environments.
+
+If you do want to set explicit credentials, then you can use the `GOOGLE_APPLICATION_CREDENTIALS` environment variable set to a path to a json credentials file.
+
+### Google AI Studio
+
+To use [Google AI Studio](https://aistudio.google.com/) models, set the relevant models in the configuration section of the configuration file:
+
+```toml
+[config] # in configuration.toml
+model="gemini/gemini-1.5-flash"
+fallback_models=["gemini/gemini-1.5-flash"]
+
+[google_ai_studio] # in .secrets.toml
+gemini_api_key = "..."
+```
+
+If you don't want to set the API key in the .secrets.toml file, you can set the `GOOGLE_AI_STUDIO.GEMINI_API_KEY` environment variable.
+
+### Anthropic
+
+To use Anthropic models, set the relevant models in the configuration section of the configuration file:
+
+```toml
+[config]
+model="anthropic/claude-3-opus-20240229"
+fallback_models=["anthropic/claude-3-opus-20240229"]
+```
+
+And also set the api key in the .secrets.toml file:
+
+```toml
+[anthropic]
+KEY = "..."
+```
+
+See [litellm](https://docs.litellm.ai/docs/providers/anthropic#usage) documentation for more information about the environment variables required for Anthropic.
+
+### Amazon Bedrock
+
+To use Amazon Bedrock and its foundational models, add the below configuration:
+
+```toml
+[config] # in configuration.toml
+model="bedrock/anthropic.claude-3-5-sonnet-20240620-v1:0"
+fallback_models=["bedrock/anthropic.claude-3-5-sonnet-20240620-v1:0"]
+
+[aws]
+AWS_ACCESS_KEY_ID="..."
+AWS_SECRET_ACCESS_KEY="..."
+AWS_REGION_NAME="..."
+```
+
+See [litellm](https://docs.litellm.ai/docs/providers/bedrock#usage) documentation for more information about the environment variables required for Amazon Bedrock.
+
+### DeepSeek
+
+To use deepseek-chat model with DeepSeek, for example, set:
+
+```toml
+[config] # in configuration.toml
+model = "deepseek/deepseek-chat"
+fallback_models=["deepseek/deepseek-chat"]
+```
+
+and fill up your key
+
+```toml
+[deepseek] # in .secrets.toml
+key = ...
+```
+
+(you can obtain a deepseek-chat key from [here](https://platform.deepseek.com))
+
+### DeepInfra
+
+To use DeepSeek model with DeepInfra, for example, set:
+
+```toml
+[config] # in configuration.toml
+model = "deepinfra/deepseek-ai/DeepSeek-R1-Distill-Llama-70B"
+fallback_models = ["deepinfra/deepseek-ai/DeepSeek-R1-Distill-Qwen-32B"]
+[deepinfra] # in .secrets.toml
+key = ... # your DeepInfra api key
+```
+
+(you can obtain a DeepInfra key from [here](https://deepinfra.com/dash/api_keys))
+
+### Mistral
+
+To use models like Mistral or Codestral with Mistral, for example, set:
+
+```toml
+[config] # in configuration.toml
+model = "mistral/mistral-small-latest"
+fallback_models = ["mistral/mistral-medium-latest"]
+[mistral] # in .secrets.toml
+key = "..." # your Mistral api key
+```
+
+(you can obtain a Mistral key from [here](https://console.mistral.ai/api-keys))
+
+### Codestral
+
+To use Codestral model with Codestral, for example, set:
+
+```toml
+[config] # in configuration.toml
+model = "codestral/codestral-latest"
+fallback_models = ["codestral/codestral-2405"]
+[codestral] # in .secrets.toml
+key = "..." # your Codestral api key
+```
+
+(you can obtain a Codestral key from [here](https://console.mistral.ai/codestral))
+
+### Openrouter
+
+To use model from Openrouter, for example, set:
+
+```toml
+[config] # in configuration.toml 
+model="openrouter/anthropic/claude-3.7-sonnet"
+fallback_models=["openrouter/deepseek/deepseek-chat"]
+custom_model_max_tokens=20000
+
+[openrouter]  # in .secrets.toml or passed an environment variable openrouter__key
+key = "..." # your openrouter api key
+```
+
+(you can obtain an Openrouter API key from [here](https://openrouter.ai/settings/keys))
+
+### Custom models
+
+If the relevant model doesn't appear [here](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/algo/__init__.py), you can still use it as a custom model:
+
+1. Set the model name in the configuration file:
+
+```toml
+[config]
+model="custom_model_name"
+fallback_models=["custom_model_name"]
+```
+
+2. Set the maximal tokens for the model:
+
+```toml
+[config]
+custom_model_max_tokens= ...
+```
+
+3. Go to [litellm documentation](https://litellm.vercel.app/docs/proxy/quick_start#supported-llms), find the model you want to use, and set the relevant environment variables.
+
+4. Most reasoning models do not support chat-style inputs (`system` and `user` messages) or temperature settings.
+To bypass chat templates and temperature controls, set `config.custom_reasoning_model = true` in your configuration file.
+
+## Dedicated parameters
+
+### OpenAI models
+
+```toml
+[config]
+reasoning_efffort= = "medium" # "low", "medium", "high"
+```
+
+With the OpenAI models that support reasoning effort (eg: o4-mini), you can specify its reasoning effort via `config` section. The default value is `medium`. You can change it to `high` or `low` based on your usage.
+
+### Anthropic models
+
+```toml
+[config]
+enable_claude_extended_thinking = false # Set to true to enable extended thinking feature
+extended_thinking_budget_tokens = 2048
+extended_thinking_max_output_tokens = 4096
+```

docs/docs/usage-guide/configuration_options.md

@@ -0,0 +1,94 @@
+The different tools and sub-tools used by Qodo Merge are adjustable via the **[configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml)**.
+
+In addition to general configuration options, each tool has its own configurations. For example, the `review` tool will use parameters from the [pr_reviewer](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L16) section in the configuration file.
+See the [Tools Guide](https://qodo-merge-docs.qodo.ai/tools/) for a detailed description of the different tools and their configurations.
+
+There are three ways to set persistent configurations:
+
+1. Wiki configuration page 💎
+2. Local configuration file
+3. Global configuration file 💎
+
+In terms of precedence, wiki configurations will override local configurations, and local configurations will override global configurations.
+
+!!! tip "Tip1: edit only what you need"
+    Your configuration file should be minimal, and edit only the relevant values. Don't copy the entire configuration options, since it can lead to legacy problems when something changes.
+!!! tip "Tip2: show relevant configurations"
+    If you set `config.output_relevant_configurations=true`, each tool will also output in a collapsible section its relevant configurations. This can be useful for debugging, or getting to know the configurations better.
+
+## Wiki configuration file 💎
+
+`Platforms supported: GitHub, GitLab, Bitbucket`
+
+With Qodo Merge, 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**.
+
+![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 (or \`\`\`toml), to allow better presentation when displayed in the wiki as markdown.
+An example content:
+
+```toml
+[pr_description]
+generate_ai_title=true
+```
+
+Qodo Merge will know to remove the surrounding quotes when reading the configuration content.
+
+## Local configuration file
+
+`Platforms supported: GitHub, GitLab, Bitbucket, Azure DevOps`
+
+By uploading a local `.pr_agent.toml` file to the root of the repo's default branch, you can edit and customize any configuration parameter. Note that you need to upload or update `.pr_agent.toml` before using the PR Agent tools (either at PR creation or via manual trigger) for the configuration to take effect.
+
+For example, if you set in `.pr_agent.toml`:
+
+```
+[pr_reviewer]
+extra_instructions="""\
+- instruction a
+- instruction b
+...
+"""
+```
+
+Then you can give a list of extra instructions to the `review` tool.
+
+## Global configuration file 💎
+
+`Platforms supported: GitHub, GitLab, Bitbucket`
+
+If you create a repo called `pr-agent-settings` in your **organization**, its configuration file `.pr_agent.toml` will be used as a global configuration file for any other repo that belongs to the same organization.
+Parameters from a local `.pr_agent.toml` file, in a specific repo, will override the global configuration parameters.
+
+For example, in the GitHub organization `Codium-ai`:
+
+- The file [`https://github.com/Codium-ai/pr-agent-settings/.pr_agent.toml`](https://github.com/Codium-ai/pr-agent-settings/blob/main/.pr_agent.toml)  serves as a global configuration file for all the repos in the GitHub organization `Codium-ai`.
+
+- The repo [`https://github.com/Codium-ai/pr-agent`](https://github.com/Codium-ai/pr-agent/blob/main/.pr_agent.toml) inherits the global configuration file from `pr-agent-settings`.
+
+### Bitbucket Organization level configuration file 💎
+
+`Relevant platforms: Bitbucket Data Center`
+
+In Bitbucket Data Center, there are two levels where you can define a global configuration file:
+
+- Project-level global configuration:
+
+Create a repository named `pr-agent-settings` within a specific project. The configuration file in this repository will apply to all repositories under the same project.
+
+- Organization-level global configuration:
+
+Create a dedicated project to hold a global configuration file that affects all repositories across all projects in your organization.
+
+**Setting up organization-level global configuration:**
+
+1. Create a new project with both the name and key: PR_AGENT_SETTINGS.
+2. Inside the PR_AGENT_SETTINGS project, create a repository named pr-agent-settings.
+3. In this repository, add a `.pr_agent.toml` configuration file—structured similarly to the global configuration file described above.
+4. Optionally, you can add organizational-level [global best practices file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#global-configuration-file).
+
+Repositories across your entire Bitbucket organization will inherit the configuration from this file.
+
+!!! note "Note"
+    If both organization-level and project-level global settings are defined, the project-level settings will take precedence over the organization-level configuration. Additionally, parameters from a repository’s local .pr_agent.toml file will always override both global settings.

docs/docs/usage-guide/enabling_a_wiki.md

@@ -0,0 +1,30 @@
+`Supported Git Platforms: GitHub, GitLab, Bitbucket`
+
+For optimal functionality of Qodo Merge, we recommend enabling a wiki for each repository where Qodo Merge is installed. The wiki serves several important purposes:
+
+**Key Wiki Features: 💎**
+
+- Storing a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file)
+- Track [accepted suggestions](https://qodo-merge-docs.qodo.ai/tools/improve/#suggestion-tracking)
+- Facilitates learning over time by creating an [auto_best_practices.md](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices) file
+
+**Setup Instructions (GitHub):**
+
+To enable a wiki for your repository:
+
+1. Navigate to your repository's main page on GitHub
+2. Select "Settings" from the top navigation bar
+3. Locate the "Features" section
+4. Enable the "Wikis" option by checking the corresponding box
+5. Return to your repository's main page
+6. Look for the newly added "Wiki" tab in the top navigation
+7. Initialize your wiki by clicking "Create the first page" and saving (this step is important - without creating an initial page, the wiki will not be fully functional)
+
+### Why Wiki?
+
+- Your code (and its derivatives, including accepted code suggestions) is yours. Qodo Merge will never store it on external servers.
+- Repository changes typically require pull requests, which create overhead and are time-consuming. This process is too cumbersome for auto data aggregation, and is not very convenient even for managing frequently updated content like configuration files.
+- A repository wiki page provides an ideal balance:
+  - It lives within your repository, making it suitable for code-related documentation
+  - It enables quick updates without the overhead of pull requests
+  - It maintains full Git version control, allowing you to track changes over time.

docs/docs/usage-guide/index.md

@@ -0,0 +1,26 @@
+# Usage guide
+
+This section provides a detailed guide on how to use Qodo Merge.
+It includes information on how to adjust Qodo Merge configurations, define which tools will run automatically, and other advanced configurations.
+
+- [Introduction](./introduction.md)
+- [Enabling a Wiki](./enabling_a_wiki)
+- [Configuration File](./configuration_options.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)
+    - [GitHub App](./automations_and_usage.md#github-app)
+    - [GitHub Action](./automations_and_usage.md#github-action)
+    - [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)
+- [Changing a Model](./changing_a_model.md)
+- [Additional Configurations](./additional_configurations.md)
+    - [Ignoring files from analysis](./additional_configurations.md#ignoring-files-from-analysis)
+    - [Extra instructions](./additional_configurations.md#extra-instructions)
+    - [Working with large PRs](./additional_configurations.md#working-with-large-prs)
+    - [Changing a model](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/)
+    - [Patch Extra Lines](./additional_configurations.md#patch-extra-lines)
+- [FAQ](https://qodo-merge-docs.qodo.ai/faq/)
+- [Qodo Merge Models](./qodo_merge_models)

docs/docs/usage-guide/introduction.md

@@ -0,0 +1,11 @@
+
+After [installation](https://qodo-merge-docs.qodo.ai/installation/), there are three basic ways to invoke Qodo Merge:
+
+1. Locally running a CLI command
+2. Online usage - by [commenting](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901){:target="_blank"} on a PR
+3. Enabling Qodo Merge tools to run automatically when a new PR is opened
+
+Specifically, CLI commands can be issued by invoking a pre-built [docker image](https://qodo-merge-docs.qodo.ai/installation/locally/#using-docker-image), or by invoking a [locally cloned repo](https://qodo-merge-docs.qodo.ai/installation/locally/#run-from-source).
+
+For online usage, you will need to setup either a [GitHub App](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-app) or a [GitHub Action](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action) (GitHub), a [GitLab webhook](https://qodo-merge-docs.qodo.ai/installation/gitlab/#run-a-gitlab-webhook-server) (GitLab), or a [BitBucket App](https://qodo-merge-docs.qodo.ai/installation/bitbucket/#run-using-codiumai-hosted-bitbucket-app) (BitBucket).
+These platforms also enable to run Qodo Merge specific tools automatically when a new PR is opened, or on each push to a branch.

docs/docs/usage-guide/mail_notifications.md

@@ -0,0 +1,18 @@
+
+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 Qodo Merge, we recommend turning off notifications for PR comments, to avoid lengthy emails:
+
+![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 Qodo Merge 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).
+
+![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 Qodo Merge tools, is to disable the help collapsible section in Qodo Merge 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/docs/usage-guide/qodo_merge_models.md

@@ -0,0 +1,42 @@
+
+The default models used by Qodo Merge (April 2025) are a combination of Claude Sonnet 3.7 and Gemini 2.5 Pro.
+
+### Selecting a Specific Model
+
+Users can configure Qodo Merge to use only a specific model by editing the [configuration](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) file.
+The models supported by Qodo Merge are:
+
+- `claude-3-7-sonnet`
+- `o4-mini`
+- `gpt-4.1`
+- `gemini-2.5-pro`
+- `deepseek/r1`
+
+To restrict Qodo Merge to using only `o4-mini`, add this setting:
+
+```toml
+[config]
+model="o4-mini"
+```
+
+To restrict Qodo Merge to using only `GPT-4.1`, add this setting:
+
+```toml
+[config]
+model="gpt-4.1"
+```
+
+To restrict Qodo Merge to using only `gemini-2.5-pro`, add this setting:
+
+```toml
+[config]
+model="gemini-2.5-pro"
+```
+
+
+To restrict Qodo Merge to using only `deepseek-r1` us-hosted, add this setting:
+
+```toml
+[config]
+model="deepseek/r1"
+```

docs/mkdocs.yml

@@ -0,0 +1,164 @@
+site_name: Qodo Merge (and open-source PR-Agent)
+repo_url: https://github.com/qodo-ai/pr-agent
+repo_name: Qodo-ai/pr-agent
+
+nav:
+  - Overview:
+    - 'index.md'
+    - 💎 Qodo Merge: 'overview/pr_agent_pro.md'
+    - Data Privacy: 'overview/data_privacy.md'
+  - Installation:
+    - 'installation/index.md'
+    - PR-Agent: 'installation/pr_agent.md'
+    - 💎 Qodo Merge: 'installation/qodo_merge.md'
+  - Usage Guide:
+    - 'usage-guide/index.md'
+    - Introduction: 'usage-guide/introduction.md'
+    - Enabling a Wiki: 'usage-guide/enabling_a_wiki.md'
+    - Configuration File: 'usage-guide/configuration_options.md'
+    - Usage and Automation: 'usage-guide/automations_and_usage.md'
+    - Managing Mail Notifications: 'usage-guide/mail_notifications.md'
+    - Changing a Model: 'usage-guide/changing_a_model.md'
+    - Additional Configurations: 'usage-guide/additional_configurations.md'
+    - Frequently Asked Questions: 'faq/index.md'
+    - 💎 Qodo Merge Models: 'usage-guide/qodo_merge_models.md'
+  - Tools:
+    - 'tools/index.md'
+    - Describe: 'tools/describe.md'
+    - Review: 'tools/review.md'
+    - Improve: 'tools/improve.md'
+    - Ask: 'tools/ask.md'
+    - Update Changelog: 'tools/update_changelog.md'
+    - Help Docs: 'tools/help_docs.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 Prompt: 'tools/custom_prompt.md'
+    - 💎 CI Feedback: 'tools/ci_feedback.md'
+    - 💎 Similar Code: 'tools/similar_code.md'
+    - 💎 Implement: 'tools/implement.md'
+    - 💎 Scan Repo Discussions: 'tools/scan_repo_discussions.md'
+    - 💎 Repo Statistics: 'tools/repo_statistics.md'
+  - Core Abilities:
+      - 'core-abilities/index.md'
+      - Auto best practices: 'core-abilities/auto_best_practices.md'
+      - Code validation: 'core-abilities/code_validation.md'
+      - Compression strategy: 'core-abilities/compression_strategy.md'
+      - Dynamic context: 'core-abilities/dynamic_context.md'
+      - Fetching ticket context: 'core-abilities/fetching_ticket_context.md'
+      - Impact evaluation: 'core-abilities/impact_evaluation.md'
+      - Interactivity: 'core-abilities/interactivity.md'
+      - Local and global metadata: 'core-abilities/metadata.md'
+      - RAG context enrichment: 'core-abilities/rag_context_enrichment.md'
+      - Self-reflection: 'core-abilities/self_reflection.md'
+      - Static code analysis: 'core-abilities/static_code_analysis.md'
+  - Chrome Extension:
+      - Qodo Merge Chrome Extension: 'chrome-extension/index.md'
+      - Features: 'chrome-extension/features.md'
+      - Data Privacy: 'chrome-extension/data_privacy.md'
+      - Options: 'chrome-extension/options.md'
+  - PR Benchmark:
+      - PR Benchmark: 'pr_benchmark/index.md'
+  - Recent Updates:
+      - Recent Updates: 'recent_updates/index.md'
+  - AI Docs Search: 'ai_search/index.md'
+#  - Code Fine-tuning Benchmark: 'finetuning_benchmark/index.md'
+
+theme:
+  logo: assets/logo.svg
+  favicon: assets/favicon.ico
+  name: material
+  icon:
+    repo: fontawesome/brands/github
+  features:
+    - navigation.tabs
+    - navigation.expand
+    - navigation.path
+    - navigation.top
+    - navigation.tracking
+    - navigation.indexes
+    - search.suggest
+    - search.highlight
+    - content.tabs.link
+    - content.code.annotation
+    - content.code.copy
+  language: en
+  custom_dir: overrides
+
+  palette:
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/toggle-switch-off-outline
+        name: Switch to dark mode
+      primary: custom
+      accent: custom
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to light mode
+      primary: custom
+      accent: custom
+
+plugins:
+  - social
+  - search
+  - glightbox
+
+extra:
+  generator: false
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/Codium-ai
+    - icon: fontawesome/brands/discord
+      link: https://discord.com/invite/SgSxuQ65GF
+    - icon: fontawesome/brands/youtube
+      link: https://www.youtube.com/@Codium-AI
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/company/codiumai
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/CodiumAI
+    - icon: fontawesome/brands/instagram
+      link: https://www.instagram.com/codiumai/
+  analytics:
+    provider: custom
+    property: ${{ secrets.GOOGLE_ANALYTICS_ID }}
+
+extra_css:
+  - css/custom.css
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - admonition
+  - pymdownx.arithmatex:
+      generic: true
+  - footnotes
+  - 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:material.extensions.emoji.to_svg
+  - pymdownx.tabbed:
+      alternate_style: true
+  - toc:
+      title: On this page
+      toc_depth: 3
+      permalink: true
+
+
+copyright: |
+  &copy; 2025 <a href="https://www.codium.ai/"  target="_blank" rel="noopener">QodoAI</a>

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/footer.html

@@ -0,0 +1,115 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>Footer</title>
+<style>
+  body {
+    margin: 0;
+    padding: 0;
+    font-family: Arial, sans-serif;
+    font-size: 16px;
+  }
+
+  .wrapper {
+    background-color: #171518;
+  }
+
+  .container {
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    justify-content: space-between;
+    color: white;
+    padding: 20px;
+    max-width: 61rem;
+    margin-left: auto;
+    margin-right: auto;
+  }
+
+  .footer-links, .social-icons {
+    padding: 0;
+    list-style-type: none;
+    display: flex;
+    justify-content: center;
+    gap: 20px;
+    align-items: center;
+  }
+
+  .footer-links a:hover, .social-icons a:hover {
+    color: #AEA1F1;
+  }
+
+  .social-icons svg {
+    width: 24px;
+    height: auto;
+    fill: white;
+  }
+
+  .footer-text {
+    width: 240px;
+  }
+
+  @media (max-width: 768px) {
+    .container {
+      flex-direction: column;
+      align-items: center;
+      text-align: center;
+    }
+
+    .footer-links, .social-icons, .footer-text {
+      width: 100%;
+      justify-content: center;
+      margin: 10px 0;
+    }
+
+    .footer-links {
+      order: 1;
+    }
+
+    .social-icons {
+      order: 2;
+    }
+
+    .footer-text {
+      order: 3;
+    }
+  }
+</style>
+</head>
+<body>
+
+<footer class="wrapper">
+  <div class="container">
+    <p class="footer-text">© 2025 <a href="https://www.qodo.ai/" target="_blank" rel="noopener">Qodo</a></p>
+    <div class="footer-links">
+      <a href="https://qodo-gen-docs.qodo.ai/">Qodo Gen</a>
+      <p>|</p>
+      <a href="https://qodo-flow-docs.qodo.ai/">AlphaCodium</a>
+    </div>
+    <div class="social-icons">
+      <a href="https://github.com/Codium-ai" target="_blank" rel="noopener" title="github.com" class="social-link">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"></path></svg>
+      </a>
+      <a href="https://discord.com/invite/SgSxuQ65GF" target="_blank" rel="noopener" title="discord.com" class="social-link">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M524.531 69.836a1.5 1.5 0 0 0-.764-.7A485.065 485.065 0 0 0 404.081 32.03a1.816 1.816 0 0 0-1.923.91 337.461 337.461 0 0 0-14.9 30.6 447.848 447.848 0 0 0-134.426 0 309.541 309.541 0 0 0-15.135-30.6 1.89 1.89 0 0 0-1.924-.91 483.689 483.689 0 0 0-119.688 37.107 1.712 1.712 0 0 0-.788.676C39.068 183.651 18.186 294.69 28.43 404.354a2.016 2.016 0 0 0 .765 1.375 487.666 487.666 0 0 0 146.825 74.189 1.9 1.9 0 0 0 2.063-.676A348.2 348.2 0 0 0 208.12 430.4a1.86 1.86 0 0 0-1.019-2.588 321.173 321.173 0 0 1-45.868-21.853 1.885 1.885 0 0 1-.185-3.126 251.047 251.047 0 0 0 9.109-7.137 1.819 1.819 0 0 1 1.9-.256c96.229 43.917 200.41 43.917 295.5 0a1.812 1.812 0 0 1 1.924.233 234.533 234.533 0 0 0 9.132 7.16 1.884 1.884 0 0 1-.162 3.126 301.407 301.407 0 0 1-45.89 21.83 1.875 1.875 0 0 0-1 2.611 391.055 391.055 0 0 0 30.014 48.815 1.864 1.864 0 0 0 2.063.7A486.048 486.048 0 0 0 610.7 405.729a1.882 1.882 0 0 0 .765-1.352c12.264-126.783-20.532-236.912-86.934-334.541ZM222.491 337.58c-28.972 0-52.844-26.587-52.844-59.239s23.409-59.241 52.844-59.241c29.665 0 53.306 26.82 52.843 59.239 0 32.654-23.41 59.241-52.843 59.241Zm195.38 0c-28.971 0-52.843-26.587-52.843-59.239s23.409-59.241 52.843-59.241c29.667 0 53.307 26.82 52.844 59.239 0 32.654-23.177 59.241-52.844 59.241Z"></path></svg>
+      </a>
+      <a href="https://www.youtube.com/@QodoAI" target="_blank" rel="noopener" title="www.youtube.com" class="social-link">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M549.655 124.083c-6.281-23.65-24.787-42.276-48.284-48.597C458.781 64 288 64 288 64S117.22 64 74.629 75.486c-23.497 6.322-42.003 24.947-48.284 48.597-11.412 42.867-11.412 132.305-11.412 132.305s0 89.438 11.412 132.305c6.281 23.65 24.787 41.5 48.284 47.821C117.22 448 288 448 288 448s170.78 0 213.371-11.486c23.497-6.321 42.003-24.171 48.284-47.821 11.412-42.867 11.412-132.305 11.412-132.305s0-89.438-11.412-132.305zm-317.51 213.508V175.185l142.739 81.205-142.739 81.201z"></path></svg>
+      </a>
+      <a href="https://www.linkedin.com/company/qodoai" target="_blank" rel="noopener" title="www.linkedin.com" class="social-link">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3zM135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5zm282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9V416z"></path></svg>
+      </a>
+      <a href="https://twitter.com/QodoAI" target="_blank" rel="noopener" title="twitter.com" class="social-link">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"></path></svg>
+      </a>
+      <a href="https://www.instagram.com/qodo_ai" target="_blank" rel="noopener" title="www.instagram.com" class="social-link">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M224.1 141c-63.6 0-114.9 51.3-114.9 114.9s51.3 114.9 114.9 114.9S339 319.5 339 255.9 287.7 141 224.1 141zm0 189.6c-41.1 0-74.7-33.5-74.7-74.7s33.5-74.7 74.7-74.7 74.7 33.5 74.7 74.7-33.6 74.7-74.7 74.7zm146.4-194.3c0 14.9-12 26.8-26.8 26.8-14.9 0-26.8-12-26.8-26.8s12-26.8 26.8-26.8 26.8 12 26.8 26.8zm76.1 27.2c-1.7-35.9-9.9-67.7-36.2-93.9-26.2-26.2-58-34.4-93.9-36.2-37-2.1-147.9-2.1-184.9 0-35.8 1.7-67.6 9.9-93.9 36.1s-34.4 58-36.2 93.9c-2.1 37-2.1 147.9 0 184.9 1.7 35.9 9.9 67.7 36.2 93.9s58 34.4 93.9 36.2c37 2.1 147.9 2.1 184.9 0 35.9-1.7 67.7-9.9 93.9-36.2 26.2-26.2 34.4-58 36.2-93.9 2.1-37 2.1-147.8 0-184.8zM398.8 388c-7.8 19.6-22.9 34.7-42.6 42.6-29.5 11.7-99.5 9-132.1 9s-102.7 2.6-132.1-9c-19.6-7.8-34.7-22.9-42.6-42.6-11.7-29.5-9-99.5-9-132.1s-2.6-102.7 9-132.1c7.8-19.6 22.9-34.7 42.6-42.6 29.5-11.7 99.5-9 132.1-9s102.7-2.6 132.1 9c19.6 7.8 34.7 22.9 42.6 42.6 11.7 29.5 9 99.5 9 132.1s2.7 102.7-9 132.1z"></path></svg>
+      </a>
+    </div>
+  </div>
+</footer>
+
+</body>
+</html>

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-M6PJSFV');</script>
+    <!-- End Google Tag Manager -->