You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .coderabbit.yaml
+26-2Lines changed: 26 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -9,8 +9,33 @@ reviews:
9
9
- "!node_modules/**"
10
10
- "!dist/**"
11
11
- "src/**"
12
-
- "zk-compression-docs/**"
13
12
- "LICENSE"
13
+
14
+
# Custom review instructions for specific paths
15
+
path_instructions:
16
+
- path: "zk-compression-docs/**/*.md"
17
+
instructions: |
18
+
When reviewing documentation changes:
19
+
1. Verify that all source code references in the documentation exist and are accurate
20
+
2. Check CLAUDE.md to ensure the page-to-source-code mapping is updated if new pages are added
21
+
3. Confirm that code examples match the actual implementation in the linked source files
22
+
4. Validate that GitHub URLs in the documentation tree are correct and accessible
23
+
24
+
- path: "zk-compression-docs/CLAUDE.md"
25
+
instructions: |
26
+
When reviewing CLAUDE.md changes:
27
+
1. Verify that all referenced source code files exist in the light-protocol repository
28
+
2. Ensure all GitHub URLs are valid and point to the correct files
29
+
3. Check that the ASCII tree structure is consistent and properly formatted
30
+
4. Confirm that new documentation pages have corresponding entries in this mapping file
31
+
32
+
# General review instructions
33
+
review_instructions: |
34
+
Cross-verify documentation with source code:
35
+
- Use CLAUDE.md as the source of truth for page-to-code mappings
36
+
- When source code files are modified, check if corresponding documentation needs updates
37
+
- When documentation is added/modified, verify the source code references are accurate
38
+
14
39
# 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
Resources for developers to learn and build: [zkcompression.com](https://www.zkcompression.com).
2
2
3
-
Visit [](https://deepwiki.com/Lightprotocol/developer-content) to query developer documentation in natural language.
3
+
Visit [](https://deepwiki.com/Lightprotocol/developer-content) to query developer documentation in natural language and for help with debugging.
0 commit comments