Skip to content

docs: scenarios doc and director-review demo materials#893

Open
GarthDB wants to merge 1 commit into
mainfrom
docs/director-review-demo-prep
Open

docs: scenarios doc and director-review demo materials#893
GarthDB wants to merge 1 commit into
mainfrom
docs/director-review-demo-prep

Conversation

@GarthDB
Copy link
Copy Markdown
Member

@GarthDB GarthDB commented May 14, 2026

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:

  • Scenario A — Prototype against an existing system (Spectrum): live token graph, machine-readable component declarations, programmatic CLI access, agent-driven Q&A
  • Scenario B — Start a blank design system: the spec contract, 31 validation rules, authoring loop, agent-authored declarations

tools/demo/ — self-contained demo assets for the review itself:

  • scenarios.md — narrated walkthrough with exact commands and what to say
  • demo-commands.sh — copy-paste cheat sheet
  • clean-component-example.json — minimal valid component declaration (shows the contract)
  • broken-token-example.tokens.json — dangling $ref that triggers SPEC-001 live
  • agent-questions.md — prepared Claude Code question for the MCP demo
  • README.md — orientation

All 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?

  • All four demo CLI commands smoke-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.json is schema-valid (verified against component.schema.json)

Types of changes

  • New feature (non-breaking change which adds functionality) — docs and demo assets only

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

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>
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 14, 2026

⚠️ No Changeset found

Latest commit: 36406ec

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@GarthDB
Copy link
Copy Markdown
Member Author

GarthDB commented May 14, 2026

Run report for 36406ec2

Total time: 6.1ms | Comparison time: 0s | Estimated loss: 6.1ms (100.0% slower)

Action Time Status Info
🟩 SyncWorkspace 6ms Passed
Touched files
docs/scenarios.md
tools/demo/README.md
tools/demo/agent-questions.md
tools/demo/broken-token-example.tokens.json
tools/demo/clean-component-example.json
tools/demo/demo-commands.sh
tools/demo/scenarios.md

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