CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Repository Overview

This is the CodeRabbit documentation repository built with Mintlify. It contains MDX documentation files organized in a hierarchical structure that maps to the CodeRabbit product documentation.

Architecture

The documentation follows a Mintlify-based structure:
  • Root level files: Core documentation pages like changelog.mdx, faq.mdx, etc.
  • getting-started/: Onboarding and setup documentation
  • guides/: Detailed how-to guides for various features
  • integrations/: Documentation for integrating with external services
  • overview/: High-level product overviews
  • platforms/: Platform-specific integration guides
  • reference/: API and configuration reference documentation
  • tools/: Documentation for CodeRabbit tools
  • images/: Static assets organized by section
The navigation structure is defined in docs.json which controls the sidebar organization and page groupings.

Development Commands

This is a Mintlify documentation project. While there’s no package.json present, typical Mintlify commands would be:
# Preview documentation locally
mintlify dev

# Build documentation
mintlify build

Key Files

  • docs.json: Main configuration file that defines navigation structure, theme colors, and page organization
  • *.mdx files: Documentation content written in MDX (Markdown with JSX)
  • /images/: Contains all documentation images organized by section