You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs/API.md is a single Markdown file. With ~15 chart types x 27 vibe presets x a brand layer, that doesn't scale — users can't find props, can't preview vibes side-by-side, and the playground (npm run playground) is a single live demo, not a reference.
Spec
New docs-site/ (or extend playground/) using Astro Starlight (preferred — markdown-first, integrates MDX, ships static).
Site contents:
Getting started (install, quick start, brand vs vibe primer).
Per-chart reference page for each component in src/components/: prop table (auto-generated from TS types via react-docgen-typescript or hand-written), 2-3 live MDX examples, gotchas, related primitives.
Vibe gallery: one bar chart rendered in every preset, click to see the resolved Rough.js knobs.
Brand gallery: same chart across a handful of brand configurations.
Why
docs/API.mdis a single Markdown file. With ~15 chart types x 27 vibe presets x a brand layer, that doesn't scale — users can't find props, can't preview vibes side-by-side, and the playground (npm run playground) is a single live demo, not a reference.Spec
docs-site/(or extendplayground/) using Astro Starlight (preferred — markdown-first, integrates MDX, ships static).src/components/: prop table (auto-generated from TS types viareact-docgen-typescriptor hand-written), 2-3 live MDX examples, gotchas, related primitives.mcp/README.mdwith per-tool examples.Acceptance
npm run docs:devandnpm run docs:buildscripts.Notes
docs/API.mdand the actual library.