Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.

Commit 7c70707

Browse files
authored
add claude code doc (#606)
1 parent fe8cfce commit 7c70707

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

CLAUDE.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## Common Development Commands
6+
7+
### Local Development
8+
9+
- `yarn install` - Install dependencies
10+
- `yarn dev` - Start VitePress development server (hot reload enabled)
11+
- `yarn build` - Build static documentation site
12+
- `yarn preview` - Preview built site locally
13+
- `make testlink` - Validate all links in markdown files using lychee
14+
15+
### Deployment
16+
17+
- Automatic deployment via GitHub Actions on push to main branch
18+
- Preview deployments available for pull requests
19+
20+
## High-Level Architecture
21+
22+
This is a **VitePress-based documentation site** for Rollkit. Key architectural elements:
23+
24+
### Content Organization
25+
26+
```
27+
docs/
28+
├── .vitepress/config.ts # Site configuration, navigation, theme
29+
├── blog/ # Blog posts and announcements
30+
├── guides/ # Step-by-step tutorials
31+
│ ├── da/ # Data availability guides
32+
│ ├── deploy/ # Deployment guides
33+
│ ├── evm/ # EVM integration guides
34+
│ └── execution/ # Execution layer guides
35+
├── learn/ # Technical documentation
36+
│ ├── sequencing/ # Sequencing concepts
37+
│ └── specs/ # Technical specifications
38+
└── public/ # Static assets and installation scripts
39+
```
40+
41+
### Key Technical Details
42+
43+
- **Static Site Generator**: VitePress with Mermaid diagram support
44+
- **Navigation Structure**: Configured in `.vitepress/config.ts` with collapsible sidebar sections
45+
- **Analytics**: Plausible analytics and Chatbase integration
46+
- **Content Format**: Markdown files with frontmatter support
47+
- **Link Validation**: Automated via `make testlink` and GitHub Actions
48+
49+
### Development Workflow
50+
51+
1. Content changes: Edit markdown files in appropriate directories
52+
2. Navigation changes: Update `.vitepress/config.ts`
53+
3. Test locally with `yarn dev`
54+
4. Validate links with `make testlink`
55+
5. Create PR - preview deployment will be available
56+
6. Merge to main triggers automatic deployment
57+
58+
### Important Conventions
59+
60+
- Use relative links for internal documentation references
61+
- Place images in `/public/img/`
62+
- Blog posts should include proper frontmatter with date and author
63+
- Guides should be structured with clear step-by-step instructions
64+
- Technical documentation in `/learn` should be comprehensive and accurate

0 commit comments

Comments
 (0)