.coderabbit.yaml

# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

language: "en-US"

reviews:
  profile: chill
  poem: false
  in_progress_fortune: false
  request_changes_workflow: false

  high_level_summary: true
  high_level_summary_in_walkthrough: true

  path_filters:
    - "!**/*.png"
    - "!**/*.jpg"
    - "!**/*.jpeg"
    - "!**/*.gif"
    - "!**/*.svg"
    - "!**/node_modules/**"
    - "!build/**"
    - "!versioned_docs/**"
    - "!versioned_sidebars/**"

  auto_review:
    enabled: true
    auto_incremental_review: true
    drafts: false
    ignore_title_keywords: ["wip", "do not merge", "draft"]
    labels: ["!wip", "!do-not-review"]

  tools:
    markdownlint:
      enabled: true
    gitleaks:
      enabled: true
    languagetool:
      enabled: true

  path_instructions:
    - path: "docs/**"
      instructions: |
        Content placement rules for the documentation site.
        Flag if a new or moved page appears to be in the wrong section.

        Decision tree — determine which section a page belongs to:
        1. Looking up facts, syntax, or specs? → References
        2. Overview, architecture, or mental model? → Overview or Concepts
        3. End-to-end scenario spanning both PE and Dev? → Tutorials
        4. AI assistants, MCP servers, or built-in agents? → Working with AI
        5. Building or extending OpenChoreo itself? → Contributor Guide
        6. Platform Engineer task (setup, config, governance)? → Platform Engineer Guide
        7. Developer task (building, deploying, operating apps)? → Developer Guide

    - path: "sidebars.ts"
      instructions: |
        Sidebar structure must follow this order:
        1. Overview
        2. Get Started
        3. Concepts
        4. Platform Engineer Guide
        5. Developer Guide
        6. Tutorials
        7. Working with AI
        8. References
        9. Contributor Guide
        10. FAQ

        Flag if new entries are added to the wrong section.