docs: scenarios doc and director-review demo materials#893
Open
GarthDB wants to merge 1 commit into
Open
Conversation
Adds docs/scenarios.md as a leave-behind reference describing the two primary workflows the design-data spec supports — prototyping against Spectrum and starting a blank design system — with the exact CLI commands for each. Adds tools/demo/ with self-contained demo assets for the May 15 design director review: a narrated walkthrough (scenarios.md), a copy-paste command cheat sheet (demo-commands.sh), a clean component example showing the spec contract, a broken token file that triggers SPEC-001 live, and a prepared agent question for the MCP demo. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Member
Author
Run report for 36406ec2Total time: 6.1ms | Comparison time: 0s | Estimated loss: 6.1ms (100.0% slower)
Touched files |
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.
Description
Two additions to support the May 15 design director review and provide a self-serve entry point afterward:
docs/scenarios.md— a leave-behind reference describing the two primary workflows the spec supports:tools/demo/— self-contained demo assets for the review itself:scenarios.md— narrated walkthrough with exact commands and what to saydemo-commands.sh— copy-paste cheat sheetclean-component-example.json— minimal valid component declaration (shows the contract)broken-token-example.tokens.json— dangling$refthat triggers SPEC-001 liveagent-questions.md— prepared Claude Code question for the MCP demoREADME.md— orientationAll CLI commands referenced in the materials have been smoke-tested end-to-end.
Related Issue
No issue — supports the design director review tomorrow (May 15) with Sean Voisen, Aaron Brownlee, Allison Shaw, and Shawn Cheris.
Motivation and Context
Phases 6–9 closed this week. The substrate is in place, but the workflows it enables aren't documented in a single place a designer or engineer can hand off. The scenarios doc closes that gap; the demo materials reduce live-demo risk during the review.
How Has This Been Tested?
design-data component button✓design-data query packages/design-data-spec --filter "component=button"✓design-data validate tools/demo/broken-token-example.tokens.json✓ (SPEC-001 fires)design-data primer packages/design-data-spec✓clean-component-example.jsonis schema-valid (verified againstcomponent.schema.json)Types of changes
Checklist: