> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Mintlify documentation example configuration

> A .coderabbit.yaml for a documentation site built with Mintlify: path filters for generated and binary files, and review instructions for MDX pages, docs.json and the changelog.

This example configures CodeRabbit for a documentation site built with Mintlify. It uses schema V2. It skips dependencies, lock files, images and the generated `openapi.json`, and gives review instructions for MDX pages, `docs.json` and `changelog.mdx`. Copy it to the root of your repository as `.coderabbit.yaml` and adjust the paths and instructions to your site.

````yaml .coderabbit.yaml theme={null}
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-US"
reviews:
  profile: "chill"
  auto_approvals:
    enabled: false
  high_level_summary: true
  poem: false
  review_status: true
  path_filters:
    - "!**/node_modules/**"
    - "!**/.github/**"
    - "!**/.vscode/**"
    - "!**/pnpm-lock.yaml"
    - "!**/package-lock.json"
    - "!**/images/**"
    - "!**/*.svg"
    - "!**/*.png"
    - "!openapi.json"
  path_instructions:
    - path: "**/*.mdx"
      instructions: |
        - When reviewing MDX files, check for duplicated content across documentation pages. If rate limits, feature descriptions, or other factual information is updated in one file, verify if similar or duplicated content exists in other MDX files that may also need updating. Raise a warning if potentially related content is found in other files but not updated.
        - CodeRabbit can be configured via web interface or via `.coderabbit.yaml` configuration file. In the documentation, both ways should be explained using the Mintlify Tabs component. Good Example: 
          ```
          <Tabs>
            <Tab title="Using configuration file">
              ```yaml
              chat:
                integrations:
                  jira:
                    usage: enabled
              ```
            </Tab>
            <Tab title="Using the Web Interface">
              ![Jira configuration](images/assets/images/jira-integration-setup.png)
            </Tab>
          </Tabs>
          ```
        - Recommend using tabs for other cases when the content is a good fit. For example, when showing mutually exclusive instructions (windows/linux, jira/linear, etc.)
        - Every time a page (.mdx file) is created, renamed, or deleted, the `/docs.json` file should be checked for needed adjustments. Example:
          ```
          File `management/seats-licenses-billing-faq.mdx` was renamed to `management/seat-assignment.mdx`. In this case, it should be also adjusted in `docs.json`. If the file existed for some time already with the old name, a redirect should be added accordingly.
          ```
        - For plan-specific feature warnings, recommend the matching compact plan badge from `/snippets/badges.jsx`, such as `EssentialsPlanBadge`, `TeamPlanBadge`, or `AdvancedPlanBadge`, instead of an inline Info, Warning, or Tip block.
    - path: "docs.json"
      instructions: |
        Check that all referenced files exist. Flag any broken file references.
    - path: "changelog.mdx"
      instructions: |
        Verify changelog entries follow consistent formatting: date, clear title, and include relevant links. Check that new entries are added chronologically.
````

## What's next

> [card] [Review instructions](https://docs.coderabbit.ai/pr-reviews/review-instructions.md)
>
> Write and scope the instructions this example sets in `path_instructions`.

> [card] [Which files are reviewed](https://docs.coderabbit.ai/pr-reviews/which-files.md)
>
> Change the `path_filters` that keep generated and binary files out of reviews.

> [card] [Example configurations](https://docs.coderabbit.ai/configuration/examples)
>
> Compare this file with the other starter configurations.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.