docs(site): scaffold VitePress at docs/ with placeholder content#20
Merged
Conversation
First execution PR for the docs-site work. Sets up VitePress at `docs/` with the structure agreed during the grilling pass: - `docs/.vitepress/config.ts` — theme config, sidebar nav across guide/reference/recipes/adr, top nav, search, edit links, footer. - Landing page `docs/index.md` — VitePress home layout, hero + feature grid pulled from the README's framing. - Guide stubs: what-is-tabmesh, getting-started, architecture, gotchas, react. Each page carries a "migrating from README" notice with a link to the canonical content. Real migration is the next PR. - Reference stubs: tabmesh-class, config, system-events, types. Same migrating notice; canonical source is the relevant types.ts. - Recipes index + 3 placeholder recipes (auth-and-logout, custom-transport, service-worker-handoff). Marked "coming soon" but contain the minimum viable explanation so they're useful as landing pages from the sidebar. - ADR index that links to the existing ADRs (0001 through 0004). ADRs are now public, accessible at /adr/* on the site. - Roadmap stub with the agreed tier-list shape (Next/Considering/ Out of scope) and a pointer to GitHub Releases for shipped work. - Playground page that iframes /playground/index.html — the iframe target gets wired up to the actual playground build in a later PR (Vercel deploy config step). Wires `docs:dev`, `docs:build`, `docs:preview` into the root package.json. Ignores `.vitepress/cache` and `.vitepress/dist` in git and biome. Verified: `pnpm docs:build` produces a clean site, every route renders, no broken sidebar links. 122 unit tests still pass.
3 tasks
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
First execution PR for the docs site work agreed during the grilling pass. Stands up VitePress at `docs/` with the structure from ADR-0004. Real content migration is the next PR — this one is about getting every route to render so we can deploy to Vercel.
What's in the site
Why this shape
Test plan
Next