Skip to content

Kl gmt 1727 website vitepress - #3423

Draft
LinKCoding wants to merge 4 commits into
mainfrom
kl-gmt-1727-website-vitepress
Draft

Kl gmt 1727 website vitepress#3423
LinKCoding wants to merge 4 commits into
mainfrom
kl-gmt-1727-website-vitepress

Conversation

@LinKCoding

@LinKCoding LinKCoding commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Overview

Adds a new VitePress documentation site for Gamut that implements the information architecture defined in ADR 0001, with fully written, live-example component docs for the button family (FillButton, StrokeButton, TextButton).

  • New packages/vitepress workspace package (VitePress + Vue theme), wired into the Yarn/Nx workspace with docs:dev / docs:build / docs:preview scripts, exposed at the root as start:vitepress and build-vitepress.
  • Sidebar/nav scaffolding for ADR 0001's full IA — Getting started, Guides, Components (grouped by function per §2: Actions, Containers, Inputs & forms, Navigation, Feedback, Status, Overlays, Data display, Typography, Media & assets, Utilities), Reference, and Concepts — with stub landing pages for sections not yet migrated.
  • Full component pages for FillButton, StrokeButton, and TextButton following the ADR §3 page template (Usage, Best practices, When NOT to use, Anatomy, Patterns, Variants, Accessibility, Props, Playground).
  • Custom VitePress theme components (ButtonPlayground.vue, ButtonVariantGrid.vue, ReactDemo.vue, react-root.tsx) that mount real @codecademy/gamut React components client-side inside GamutProvider, so Patterns/Variants/Playground sections render live, interactive buttons rather than static code samples.
  • docs/adr/0001-documentation-site-information-architecture.md documents the IA rationale this site follows.

PR Checklist

  • Related to designs:
  • Related to JIRA ticket: GMT-1727
  • Version plan added/updated (or not needed)
  • I have run this code to verify it works
  • This PR includes unit tests for the code change
  • This PR includes testing instructions tests for the code change
  • The alpha package of this PR is passing end-to-end tests in all relevant Codecademy repositories

Testing Instructions

Don't make me tap the sign.

  1. From the repo root, run yarn to install the new packages/vitepress workspace dependencies.
  2. Run yarn start:vitepress (or cd packages/vitepress && yarn docs:dev) and open the printed local URL.
  3. Confirm the top nav (Getting started / Guides / Components / Reference / Concepts) and the Components sidebar match ADR 0001's functional grouping (Actions, Containers, Inputs & forms, etc.).
  4. Open Components → Actions → FillButton (and StrokeButton, TextButton) and confirm each page renders in the fixed section order: Usage, Best practices, When NOT to use, Anatomy, Patterns, Variants, Accessibility, Props, Playground.
  5. In the Patterns section on FillButton, click "Save changes" in the busy-state example and confirm the label cycles through Saving…/Saved on a real, interactive button (not a static screenshot).
  6. In the Playground at the bottom of any of the three button pages, change the Variant, Size, and Label controls and confirm the rendered button updates live.
  7. Run yarn build-vitepress (or cd packages/vitepress && yarn docs:build) and confirm the static build completes without errors.

PR Links and Envs

Repository PR Link
Monolith Monolith PR
Mono Mono PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant