diff --git a/.coderabbit.yaml b/.coderabbit.yaml index 5de3c31..6a2810e 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -9,6 +9,7 @@ reviews: - "!node_modules/**" - "!dist/**" - "src/**" + - "zk-compression-docs/**" - "LICENSE" # Custom review instructions for specific paths diff --git a/zk-compression-docs/CLAUDE.md b/zk-compression-docs/CLAUDE.md index 1e8cb55..b13edf6 100644 --- a/zk-compression-docs/CLAUDE.md +++ b/zk-compression-docs/CLAUDE.md @@ -23,13 +23,13 @@ Maps documentation pages to source code and examples. ## Key Repositories -- **light-protocol**: https://github.com/Lightprotocol/light-protocol -- **photon**: https://github.com/helius-labs/photon -- **program-examples**: https://github.com/Lightprotocol/program-examples +- **light-protocol**: +- **photon**: +- **program-examples**: ## Compressed Tokens -``` +```text Compressed Tokens ├── Overview (compressed-tokens/overview.md) │ └── src: https://github.com/Lightprotocol/light-protocol/tree/main/js/compressed-token @@ -88,7 +88,7 @@ Compressed Tokens ## Compressed PDAs -``` +```text Compressed PDAs ├── Create a Program with Compressed PDAs (compressed-pdas/create-a-program-with-compressed-pdas.md) │ ├── src: https://github.com/Lightprotocol/light-protocol/tree/main/sdk-libs/sdk @@ -150,7 +150,7 @@ Compressed PDAs ## Learn -``` +```text Learn ├── Core Concepts (learn/core-concepts/README.md) │ ├── Compressed Account Model (compressed-account-model.md) @@ -180,7 +180,7 @@ Learn ## Resources -``` +```text Resources ├── CLI Installation (cli-installation.md) │ ├── CLI source: https://github.com/Lightprotocol/light-protocol/tree/main/cli @@ -274,12 +274,15 @@ Resources ## References -├── Whitepaper (references/whitepaper.md) -│ └── PDF: https://github.com/Lightprotocol/light-protocol/blob/main/light_paper_v0.1.0.pdf -├── Node Operators (references/node-operators.md) -│ ├── Photon indexer: https://github.com/helius-labs/photon -│ ├── Prover: https://github.com/Lightprotocol/light-protocol/tree/main/light-prover -│ └── Forester: https://github.com/Lightprotocol/light-protocol/tree/main/forester -├── Terminology (references/terminology.md) -└── Security (references/security.md) - └── audits: https://github.com/Lightprotocol/light-protocol/tree/main/audits \ No newline at end of file +```text +References + ├── Whitepaper (references/whitepaper.md) + │ └── PDF: + ├── Node Operators (references/node-operators.md) + │ ├── Photon indexer: + │ ├── Prover: + │ └── Forester: + ├── Terminology (references/terminology.md) + └── Security (references/security.md) + └── audits: +``` \ No newline at end of file diff --git a/zk-compression-docs/compressed-pdas/client-library/README.md b/zk-compression-docs/compressed-pdas/client-library/client-guide.md similarity index 100% rename from zk-compression-docs/compressed-pdas/client-library/README.md rename to zk-compression-docs/compressed-pdas/client-library/client-guide.md