mirror of
https://github.com/jimeh/commonflow.org.git
synced 2026-02-19 05:46:40 +00:00
61 lines
1.7 KiB
Markdown
61 lines
1.7 KiB
Markdown
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code (claude.ai/code) when working with
|
|
code in this repository.
|
|
|
|
## Project Overview
|
|
|
|
This is the source for commonflow.org, an Astro-based static site that documents
|
|
the Git Common-Flow specification. Common-Flow is a git workflow specification
|
|
that combines GitHub Flow with versioned releases.
|
|
|
|
## Build Commands
|
|
|
|
```bash
|
|
# Install tooling (bun) via mise
|
|
mise install
|
|
|
|
# Install dependencies
|
|
bun install
|
|
|
|
# Development server
|
|
bun run dev
|
|
|
|
# Build site (outputs to docs/ directory)
|
|
bun run build
|
|
|
|
# Preview built site
|
|
bun run preview
|
|
|
|
# Update specs from upstream (fetches from github.com/jimeh/common-flow)
|
|
bun run update
|
|
```
|
|
|
|
The site is built to `docs/` for GitHub Pages hosting.
|
|
|
|
## Architecture
|
|
|
|
- **Astro 5.x** static site generator
|
|
- **Tailwind CSS 4.x** for styling with dark mode support
|
|
- **Content Collections** for spec markdown files
|
|
- **TypeScript** throughout
|
|
- **Bun** as JavaScript runtime and package manager (managed via mise)
|
|
|
|
### Key Files
|
|
|
|
- `src/config.ts` - Site configuration with version list
|
|
- `src/content.config.ts` - Astro content collection definition
|
|
- `src/layouts/Default.astro` - Main layout with sidebar
|
|
- `src/components/` - Sidebar, MenuToggle, ThemeToggle components
|
|
- `src/pages/spec/[version].astro` - Dynamic route for spec versions
|
|
- `src/content/spec/*.md` - Versioned spec documents
|
|
- `public/spec/*.svg` - SVG diagrams for each version
|
|
- `scripts/update-specs.ts` - Fetches specs from GitHub
|
|
|
|
### Updating Spec Versions
|
|
|
|
1. Add new version to `versions` array in `src/config.ts`
|
|
2. Update `currentVersion` if this is the new default
|
|
3. Run `bun run update` to fetch specs from GitHub
|
|
4. Run `bun run build` to rebuild the site
|