Skip to content

Commit ea3b73f

Browse files
claudejaredpalmer
authored andcommitted
docs: add documentation website section to CLAUDE.md
1 parent 3c692fe commit ea3b73f

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CLAUDE.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,37 @@ The e2e tests create projects in temp directories and have longer timeouts (60s)
4949
2. Register in `src/index.ts` in the `templates` object
5050
3. Include: package.json, tsconfig.json, vitest.config.ts, src/, test/, gitignore (not .gitignore), LICENSE with `<year>` and `<author>` placeholders
5151

52+
## Documentation Website
53+
54+
The documentation site is in `./website/` and built with:
55+
- **Next.js 16** - React framework
56+
- **Fumadocs** - Documentation framework (fumadocs-core, fumadocs-mdx, fumadocs-ui)
57+
- **Tailwind CSS v4** - CSS-first configuration
58+
- **IBM Plex Sans/Mono** - Typography via next/font/google
59+
60+
### Website Commands
61+
62+
```bash
63+
cd website
64+
bun install # Install dependencies
65+
bun run dev # Start dev server
66+
bun run build # Build for production
67+
```
68+
69+
### Content Structure
70+
71+
- `content/docs/` - MDX documentation files
72+
- `content/docs/meta.json` - Sidebar navigation structure
73+
- `app/` - Next.js App Router pages
74+
- `app/layout.config.tsx` - Navigation and logo configuration
75+
76+
### Adding Documentation Pages
77+
78+
1. Create `.mdx` file in `content/docs/`
79+
2. Add frontmatter with `title` and `description`
80+
3. Add page to `content/docs/meta.json` in desired position
81+
4. Use `---Section Name---` syntax in meta.json for sidebar sections
82+
5283
## Commit Convention
5384

5485
Uses Conventional Commits: `feat:`, `fix:`, `docs:`, `test:`, `refactor:`, `chore:`

0 commit comments

Comments
 (0)