Skip to content

Commit 0ed6445

Browse files
committed
Add CLAUDE.md
1 parent bc8f01f commit 0ed6445

File tree

2 files changed

+50
-20
lines changed

2 files changed

+50
-20
lines changed

.github/workflows/openhands.yaml

Lines changed: 0 additions & 20 deletions
This file was deleted.

CLAUDE.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## Development Commands
6+
7+
```bash
8+
# Start development server
9+
pnpm dev
10+
11+
# Build for production
12+
pnpm build
13+
14+
# Preview built site
15+
pnpm preview
16+
```
17+
18+
## Project Architecture
19+
20+
This is a Vocs-based documentation site for Cartridge - a high-performance infrastructure platform for provable games and applications. The project structure is:
21+
22+
### Core Components
23+
- **Vocs Framework**: Static site generator optimized for documentation
24+
- **React Components**: Custom components like `Homepage.tsx` for landing page
25+
- **Markdown/MDX Pages**: Documentation content in `src/pages/`
26+
27+
### Content Organization
28+
The documentation covers three main products:
29+
30+
1. **Controller** (`/controller/*`): Gaming-focused smart contract wallet with session keys, passkey support, paymaster functionality, achievements system, and inventory management
31+
2. **Slot** (`/slot/*`): Horizontally scalable execution sharding platform with VRF (Verifiable Random Function) support
32+
3. **Arcade** (`/arcade/*`): Central hub connecting players and onchain games
33+
34+
### Key Configuration
35+
- `vocs.config.ts`: Main configuration with separate sidebars for each product section
36+
- Uses dark theme with custom color scheme (#ffc52a accent, #0c0c0c background)
37+
- GitHub integration for edit links and social links
38+
- Banner component for community engagement
39+
40+
### Styling & Assets
41+
- Tailwind CSS configuration in `tailwind.config.cjs`
42+
- SVG icons in `src/public/` loaded via vite-plugin-svgr
43+
- Custom CSS variables defined in vocs theme configuration
44+
45+
### Package Management
46+
- Uses pnpm as package manager
47+
- Key dependencies: React 18, Starknet libraries, Cartridge connector
48+
- Vocs alpha version (1.0.0-alpha.55)
49+
50+
When editing content, maintain the existing markdown structure and follow the established sidebar navigation patterns in `vocs.config.ts`.

0 commit comments

Comments
 (0)