herdctl
CLAUDE.md38 starsChanged 8 months agoMITView on GitHub
Astro + Starlight documentation site. Deploys to herdctl.dev via Cloudflare Pages. Run pnpm build && pnpm preview to see the site with Mermaid diagrams rendered. Never rely on pnpm dev (astro dev) for visual verification — Mermaid diagrams do not render in dev mode. Write all documentation pages as .md or .mdx files in src/content/docs/. Use Mermaid code blocks for inline diagrams. Mermaid is configured via rehype-mermaid with client-side rendering. Manage the sidebar manually in astro.config.mjs under the sidebar array.…
The file
We split this CLAUDE.md into the rules it gives an agent
4 rules. About 0 are common, 0 are distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 7
Run pnpm build && pnpm preview to see the site with Mermaid diagrams rendered.
- Very specific: line 8
Never rely on pnpm dev (astro dev) for visual verification — Mermaid diagrams do not render in dev mode.
- Very specific: line 12
Write all documentation pages as .md or .mdx files in src/content/docs/.
- Very specific: line 13
Use Mermaid code blocks for inline diagrams.
≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
docs/CLAUDE.md
Astro + Starlight documentation site. Deploys to herdctl.dev via Cloudflare Pages.
Build & Preview
Run pnpm build && pnpm preview to see the site with Mermaid diagrams rendered.
Never rely on pnpm dev (astro dev) for visual verification — Mermaid diagrams do not render in dev mode.
Content
Write all documentation pages as .md or .mdx files in src/content/docs/.
Use Mermaid code blocks for inline diagrams. Mermaid is configured via rehype-mermaid with client-side rendering.
Sidebar
Manage the sidebar manually in astro.config.mjs under the sidebar array. Add new pages there explicitly — Starlight does not auto-discover content.
Landing Page
Custom landing page components live in src/components/landing/. These use raw Tailwind and Inter font — they do NOT use herd-* design tokens from the web dashboard. Do not confuse these with packages/web/ conventions.
D2 Diagrams
D2 source files live in docs/d2/. Read .claude/rules/diagrams.md for the full D2 workflow, render commands, and the project color palette. Always use --pad=20 when rendering.
Redirects
Define URL redirects in astro.config.mjs under redirects. Update these when moving or renaming pages.
Analytics
PostHog analytics are proxied through Cloudflare. Configuration is inline in astro.config.mjs head scripts.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.