pr-agent/docs/mkdocs.yml

site_name: Qodo Merge (formerly known as PR-Agent)
repo_url: https://github.com/Codium-ai/pr-agent
repo_name: Codium-ai/pr-agent

nav:
  - Overview:
    - 'index.md'
    - 💎 Qodo Merge Pro: 'overview/pr_agent_pro.md'
    - Data Privacy: 'overview/data_privacy.md'
  - Installation:
    - 'installation/index.md'
    - Locally: 'installation/locally.md'
    - GitHub: 'installation/github.md'
    - GitLab: 'installation/gitlab.md'
    - BitBucket: 'installation/bitbucket.md'
    - Azure DevOps: 'installation/azure.md'
    - 💎 Qodo Merge Pro: 'installation/pr_agent_pro.md'
  - Usage Guide:
    - 'usage-guide/index.md'
    - Introduction: 'usage-guide/introduction.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'
    - 💎 Qodo Merge Pro Models: 'usage-guide/PR_agent_pro_models'
  - 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'
    - Similar Issues: 'tools/similar_issues.md'
    - Help: 'tools/help.md'
    - 💎 Analyze: 'tools/analyze.md'
    - 💎 Test: 'tools/test.md'
    - 💎 Improve Component: 'tools/improve_component.md'
    - 💎 Documentation: 'tools/documentation.md'
    - 💎 Custom Labels: 'tools/custom_labels.md'
    - 💎 Custom Prompt: 'tools/custom_prompt.md'
    - 💎 CI Feedback: 'tools/ci_feedback.md'
    - 💎 Similar Code: 'tools/similar_code.md'
  - Core Abilities:
      - 'core-abilities/index.md'
      - Local and global metadata: 'core-abilities/metadata.md'
      - Dynamic context: 'core-abilities/dynamic_context.md'
      - Self-reflection: 'core-abilities/self_reflection.md'
      - Impact evaluation: 'core-abilities/impact_evaluation.md'
      - Interactivity: 'core-abilities/interactivity.md'
      - Compression strategy: 'core-abilities/compression_strategy.md'
      - Code-oriented YAML: 'core-abilities/code_oriented_yaml.md'
      - Static code analysis: 'core-abilities/static_code_analysis.md'
      - Code Fine-tuning Benchmark: 'finetuning_benchmark/index.md'
  - Chrome Extension:
      - Qodo Merge Chrome Extension: 'chrome-extension/index.md'
      - Features: 'chrome-extension/features.md'
      - Data Privacy: 'chrome-extension/data_privacy.md'
  - FAQ:
      - FAQ: 'faq/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
    - content.tabs.link
  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"
  - toc:
      title: On this page
      toc_depth: 3
      permalink: true


copyright: |
  &copy; 2024 <a href="https://www.codium.ai/"  target="_blank" rel="noopener">CodiumAI</a>