docs(DX-2): ADOPTING.md — the 12-step adoption journey#27
Merged
Conversation
…beled The complete path from an existing code design system to a locally validated contract, with each step labeled Automated / Human review / Design decision, the shadcn contract's git history as the worked example for governance authoring (prose first, law second), and honest notes on current mechanics (validate-in-a-checkout, snapshot overwrite semantics). Verified by executing the guide end to end from clean checkouts; the clarifications that run surfaced (output naming, id conventions, the minimal example skeleton) are folded in. README links the guide from the charter block. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new end-to-end adoption guide for taking an existing design system to a locally validated dspack contract, and links that guide from the main README to improve discoverability.
Changes:
- Introduces
ADOPTING.mddescribing a 12-step, three-phase adoption journey (snapshot → governance → validate/use) with worked examples and command walkthroughs. - Adds a prominent README pointer to the new adoption guide.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds a direct link to the new adoption guide for existing design systems. |
| ADOPTING.md | New comprehensive adoption guide documenting snapshot extraction, governance authoring, validation, and downstream usage. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+28
to
+32
| | # | Step | Mode | | ||
| |---|------|------| | ||
| | 1 | [Extract a snapshot from your codebase](#step-1--extract-a-snapshot) | 🤖 Automated | | ||
| | 2 | [Set the version to the current spec](#step-2--set-the-version) | 🤖 Automated | | ||
| | 3 | [Review the snapshot against reality](#step-3--review-the-snapshot) | 👀 Human review | |
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.
DX-2 (The Adoption Guide) — main deliverable, per the accepted RFC (§2, §6 DX-2).
examples/dir (standalonevalidate --fileflagged as a known roadmap gap), snapshot overwrite semantics ("commit, then enrich; don't regenerate over enrichments"), emit-profile authoring deferred to dspack-emit's guide. No dspack-export behavior changes, no bootstrap-boundary changes (DX-3 territory).npm run validategreen in a fresh dspack clone → served by published ds-mcp (whenToUse queryable) →dspack-gen contextcompiled (example appears in fewshot) →dspack-gen linton a violating surface exits 2 with the authored rule's rationale verbatim. Three clarifications the walkthrough surfaced (output filename source, per-block id conventions, minimal example skeleton) are folded into the guide.Companion PRs: emit-profile guide in dspack-emit; one-line README link-ins in ds-mcp / dspack-gen / dspack-export.
🤖 Generated with Claude Code