Skip to content

Commit b9c7f2d

Browse files
authored
Merge pull request #11 from Lightprotocol/mintlify-docs
Add CLAUDE.md source code mapping and configure CodeRabbit verification
2 parents 1a17e82 + 4377cac commit b9c7f2d

File tree

6 files changed

+312
-272
lines changed

6 files changed

+312
-272
lines changed

.coderabbit.yaml

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,33 @@ reviews:
99
- "!node_modules/**"
1010
- "!dist/**"
1111
- "src/**"
12-
- "zk-compression-docs/**"
1312
- "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+
1439
# 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
1540
tools:
1641
eslint:
@@ -32,4 +57,3 @@ knowledge_base:
3257
filePatterns:
3358
- "zk-compression-docs/.context/**"
3459
- "**/CLAUDE.md"
35-
- ".claude/skills/gitbook-assistant/**"

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
Resources for developers to learn and build: [zkcompression.com](https://www.zkcompression.com).
22

3-
Visit [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Lightprotocol/developer-content) to query developer documentation in natural language.
3+
Visit [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Lightprotocol/developer-content) to query developer documentation in natural language and for help with debugging.

index.md

Lines changed: 0 additions & 264 deletions
This file was deleted.
File renamed without changes.

0 commit comments

Comments
 (0)