developer-content/.coderabbit.yaml at main · mintlify-onboarding/developer-content · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: en-US
tone_instructions: "You are a principal engineer with natural teaching abilities. You detect issues and clearly explain why."
reviews:
  profile: assertive
  high_level_summary: true
  #paths to ignore, customize for your stack
  path_filters:
    - "!node_modules/**"
    - "!dist/**"
    - "src/**"
    - "zk-compression-docs/**"
    - "LICENSE"

  # Custom review instructions for specific paths
  path_instructions:
    - path: "zk-compression-docs/**/*.md"
      instructions: |
        When reviewing documentation changes:
        1. Verify that all source code references in the documentation exist and are accurate
        2. Check CLAUDE.md to ensure the page-to-source-code mapping is updated if new pages are added
        3. Confirm that code examples match the actual implementation in the linked source files
        4. Validate that GitHub URLs in the documentation tree are correct and accessible

    - path: "zk-compression-docs/CLAUDE.md"
      instructions: |
        When reviewing CLAUDE.md changes:
        1. Verify that all referenced source code files exist in the light-protocol repository
        2. Ensure all GitHub URLs are valid and point to the correct files
        3. Check that the ASCII tree structure is consistent and properly formatted
        4. Confirm that new documentation pages have corresponding entries in this mapping file

  # General review instructions
  review_instructions: |
    Cross-verify documentation with source code:
    - Use CLAUDE.md as the source of truth for page-to-code mappings
    - When source code files are modified, check if corresponding documentation needs updates
    - When documentation is added/modified, verify the source code references are accurate

# add linters and other tools, CodeRabbit will run and check these as part of its review process. See a list of supported tools: https://docs.coderabbit.ai/tools/list
  tools:
    eslint:
      enabled: true
    ruff:
      enabled: true
    gitleaks:
      enabled: true
  auto_review:
    enabled: true
    drafts: false
    ignore_title_keywords:
      - "wip"
      - "draft"
knowledge_base:
  # Coding guidelines automatically detects major coding agents, Cursor, Claude Code, Gemini, et. al. If you keep custom coding standards or other documents, say architectural patterns, add them as file patterns.
  code_guidelines:
    enabled: true
    filePatterns:
      - "zk-compression-docs/.context/**"
      - "**/CLAUDE.md"