docs: Astro Starlight site scaffold + seed pages (#128, phase 1)#135
Merged
Conversation
docs/API.md doesn't scale across 15 charts and 27 vibes. Bootstraps an Astro Starlight site so we get sidebar nav, MDX, search, dark mode, and a stable place to grow per-chart references and recipes. - new docs-site/ workspace: package.json, astro.config.mjs, tsconfig, content.config.ts - seed pages: - Introduction (splash) - Quick start - Brand vs. vibe - BarChart reference (full prop table — template for the other charts) - Recipes: Responsive sizing, Dark mode, Export to PNG/SVG - MCP server overview - Vibe gallery (with a link to the playground for live previews) - root package.json gains `docs:dev` / `docs:build` scripts proxying into docs-site - README inside docs-site documents the phase-1 scope and what's deferred (14 more chart pages, auto-generated prop tables off TS types, CI deploy alongside the existing GH Pages playground) No library changes; existing typecheck/test/build/bundle all unchanged.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs-site/workspace running Astro Starlight (separate package, not in the library install).package.jsongainsnpm run docs:dev/docs:buildproxying intodocs-site/.docs-site/README.mdcalls out what phase 1 covers and what's tracked as follow-ups.Why phase 1, not the full site
The issue spec calls for all 15 chart pages + auto-generated prop tables + CI deploy. Trying to land that in one PR risks getting blocked on auto-doc tooling (
react-docgen-typescript) or the GitHub Pages deploy re-wiring. Phase 1 ships the scaffold + the BarChart template + the high-value recipes; the remaining content is straightforward markdown to write once the bones are in place.What's deferred (tracked under #128)
react-docgen-typescript).Verification
npm run typecheckclean (root)npm test— 421 tests pass (unchanged — no library code touched)npm run build && npm run check:bundle— browser entry 51 KB gzipped (unchanged)docs-site/install + build not exercised in CI yet (no workflow change)Test plan
cd docs-site && npm install && npm run devCloses phase 1 of #128.