Kl gmt 1727 website vitepress - #3423
Draft
LinKCoding wants to merge 4 commits into
Draft
Conversation
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
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.
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).
packages/vitepressworkspace package (VitePress + Vue theme), wired into the Yarn/Nx workspace withdocs:dev/docs:build/docs:previewscripts, exposed at the root asstart:vitepressandbuild-vitepress.FillButton,StrokeButton, andTextButtonfollowing the ADR §3 page template (Usage, Best practices, When NOT to use, Anatomy, Patterns, Variants, Accessibility, Props, Playground).ButtonPlayground.vue,ButtonVariantGrid.vue,ReactDemo.vue,react-root.tsx) that mount real@codecademy/gamutReact components client-side insideGamutProvider, so Patterns/Variants/Playground sections render live, interactive buttons rather than static code samples.docs/adr/0001-documentation-site-information-architecture.mddocuments the IA rationale this site follows.PR Checklist
Testing Instructions
Don't make me tap the sign.
yarnto install the newpackages/vitepressworkspace dependencies.yarn start:vitepress(orcd packages/vitepress && yarn docs:dev) and open the printed local URL.yarn build-vitepress(orcd packages/vitepress && yarn docs:build) and confirm the static build completes without errors.PR Links and Envs