This repository was archived by the owner on Aug 7, 2025. It is now read-only.
chore: add claude code doc #606
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,64 @@ | ||||||||||
| # CLAUDE.md | ||||||||||
|
|
||||||||||
| This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. | ||||||||||
|
|
||||||||||
| ## Common Development Commands | ||||||||||
|
|
||||||||||
| ### Local Development | ||||||||||
|
|
||||||||||
| - `yarn install` - Install dependencies | ||||||||||
| - `yarn dev` - Start VitePress development server (hot reload enabled) | ||||||||||
| - `yarn build` - Build static documentation site | ||||||||||
| - `yarn preview` - Preview built site locally | ||||||||||
| - `make testlink` - Validate all links in markdown files using lychee | ||||||||||
|
|
||||||||||
| ### Deployment | ||||||||||
|
|
||||||||||
| - Automatic deployment via GitHub Actions on push to main branch | ||||||||||
| - Preview deployments available for pull requests | ||||||||||
|
|
||||||||||
| ## High-Level Architecture | ||||||||||
|
|
||||||||||
| This is a **VitePress-based documentation site** for Rollkit. Key architectural elements: | ||||||||||
|
|
||||||||||
| ### Content Organization | ||||||||||
|
|
||||||||||
| ``` | ||||||||||
| docs/ | ||||||||||
| ├── .vitepress/config.ts # Site configuration, navigation, theme | ||||||||||
| ├── blog/ # Blog posts and announcements | ||||||||||
| ├── guides/ # Step-by-step tutorials | ||||||||||
| │ ├── da/ # Data availability guides | ||||||||||
| │ ├── deploy/ # Deployment guides | ||||||||||
| │ ├── evm/ # EVM integration guides | ||||||||||
| │ └── execution/ # Execution layer guides | ||||||||||
| ├── learn/ # Technical documentation | ||||||||||
| │ ├── sequencing/ # Sequencing concepts | ||||||||||
| │ └── specs/ # Technical specifications | ||||||||||
|
Comment on lines
+36
to
+37
Contributor
There was a problem hiding this comment. Consider aligning the comments for the subdirectories under
Suggested change
|
||||||||||
| └── public/ # Static assets and installation scripts | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| ### Key Technical Details | ||||||||||
|
|
||||||||||
| - **Static Site Generator**: VitePress with Mermaid diagram support | ||||||||||
| - **Navigation Structure**: Configured in `.vitepress/config.ts` with collapsible sidebar sections | ||||||||||
| - **Analytics**: Plausible analytics and Chatbase integration | ||||||||||
| - **Content Format**: Markdown files with frontmatter support | ||||||||||
| - **Link Validation**: Automated via `make testlink` and GitHub Actions | ||||||||||
|
|
||||||||||
| ### Development Workflow | ||||||||||
|
|
||||||||||
| 1. Content changes: Edit markdown files in appropriate directories | ||||||||||
| 2. Navigation changes: Update `.vitepress/config.ts` | ||||||||||
| 3. Test locally with `yarn dev` | ||||||||||
| 4. Validate links with `make testlink` | ||||||||||
| 5. Create PR - preview deployment will be available | ||||||||||
| 6. Merge to main triggers automatic deployment | ||||||||||
|
|
||||||||||
| ### Important Conventions | ||||||||||
|
|
||||||||||
| - Use relative links for internal documentation references | ||||||||||
| - Place images in `/public/img/` | ||||||||||
|
Contributor
There was a problem hiding this comment. To avoid ambiguity, clarify the path Clarify both the location for placing images and the convention for referencing them.
Suggested change
|
||||||||||
| - Blog posts should include proper frontmatter with date and author | ||||||||||
| - Guides should be structured with clear step-by-step instructions | ||||||||||
| - Technical documentation in `/learn` should be comprehensive and accurate | ||||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For improved readability and maintainability, consider aligning the comments in this file structure overview. This makes the tree easier to parse visually.