Skip to content

Conversation

@tilo-14
Copy link
Contributor

@tilo-14 tilo-14 commented Nov 9, 2025

Summary

Adds comprehensive documentation-to-source-code mapping and automated verification workflows to improve documentation accuracy and maintenance.

Key Changes

CLAUDE.md - Documentation Source Code Mapping

  • Complete ASCII tree structure mapping all documentation pages to their source code and examples
  • GitHub URLs for all TypeScript/Rust implementations, RPC methods, and program examples
  • Quick navigation, link prefix legend, and key repository references
  • Replaces index.md with more comprehensive and maintainable structure

CodeRabbit Configuration

  • Add path-specific review instructions for zk-compression-docs/**/*.md
  • Add specialized verification for CLAUDE.md changes
  • Configure cross-verification between documentation and source code
  • Use CLAUDE.md as source of truth for page-to-code mappings

Documentation Improvements

  • Client library README: remove Native Rust sections (now Anchor-only)
  • Fix Rust client library description
  • Improve wording and formatting consistency
  • Fix heading hierarchy and add missing documentation

Other Changes

  • Update README.md to clarify DeepWiki debugging support
  • Archive event-1000x-hackathon-sidetracks.md
  • Add zk-compression-docs to CodeRabbit path filters

Benefits

  1. Automated Verification: CodeRabbit will verify all doc changes against source code
  2. Single Source of Truth: CLAUDE.md maps all pages to implementations
  3. Improved Maintenance: Easier to spot documentation drift
  4. Better AI Context: Structured mapping improves AI-assisted development
  5. Quality Assurance: Validates GitHub URLs and code references on every PR

Testing

  • Verified all GitHub URLs in CLAUDE.md are accessible
  • Confirmed ASCII tree structure renders correctly
  • Validated CodeRabbit YAML syntax

🤖 Generated with Claude Code

- Add CLAUDE.md: ASCII tree mapping docs to source code/examples with GitHub URLs
- Configure CodeRabbit: add path_instructions for doc-to-code verification
- Update README.md: clarify DeepWiki debugging support
- Improve client library README: remove Native Rust sections (Anchor-only)
- Remove index.md: superseded by CLAUDE.md
- Archive event-1000x-hackathon-sidetracks.md
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 9, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (6)
  • .coderabbit.yaml is excluded by none and included by none
  • README.md is excluded by none and included by none
  • index.md is excluded by none and included by none
  • zk-compression-docs/.event-1000x-hackathon-sidetracks.md is excluded by none and included by none
  • zk-compression-docs/CLAUDE.md is excluded by none and included by none
  • zk-compression-docs/compressed-pdas/client-library/README.md is excluded by none and included by none

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch mintlify-docs

Comment @coderabbitai help to get the list of available commands and usage tips.

@tilo-14 tilo-14 merged commit b9c7f2d into main Nov 9, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants