docs(DX-1): single-source tool docs (D1), rename v0.1 example (D4), breadcrumb + charter - #24
Merged
Merged
Conversation
…+ charter - D1: docs/README.md carried a stale seven-tool table contradicting the main README and architecture.md (eleven); it now defers to the main README's table, which is maintained in exactly one place. - D4 (compatibility-aware): examples/shadcn-ui.dspack.json (v0.1) -> examples/shadcn-ui-v01.dspack.json, so no unversioned filename can mean a different spec version than the dspack repository's v0.4 file of the same name. Dependents inventoried and updated in the same change (README, demo-shadcn walkthrough, pre-merge checklist, smoke.sh — which now exercises the synced v0.4 example); no sibling repository references the old path; deprecation recorded in README and CHANGELOG (Unreleased). - Breadcrumb to the org overview + kind/audience/neighbors charter; studio backlink with the hosted replay URL; export description catches up to Vue 3 + Vuetify 3 and DTCG import. Verified: npm test 94/94; scripts/smoke.sh end-to-end pass (11 tools). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aligns ds-mcp’s documentation and examples with the DX-1 “Truth & Wayfinding” goal by removing duplicated tool documentation, renaming the v0.1 shadcn/ui example to a versioned filename, and adding ecosystem wayfinding/breadcrumb context to the main README.
Changes:
- Single-sourced the tools table by pointing
docs/README.mdto the canonical table in the main README. - Renamed the v0.1 shadcn/ui example to
examples/shadcn-ui-v01.dspack.jsonand updated in-repo references. - Updated docs and smoke script to consistently emphasize/consume the v0.4 example, plus added ecosystem breadcrumb/charter context.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| scripts/smoke.sh | Switches the smoke test to use the v0.4 example file. |
| README.md | Adds ecosystem breadcrumb/charter text and updates example references + dspack-export section. |
| examples/shadcn-ui-v01.dspack.json | Adds the versioned v0.1 example contract file. |
| docs/README.md | Removes duplicated tool table and links to the canonical table in the main README. |
| docs/pre-merge-checklist.md | Updates checklist to reference the renamed v0.1 example file. |
| docs/demo-shadcn.md | Updates the v0.1 example link to the renamed file. |
| CHANGELOG.md | Records the v0.1 example rename and the rationale in Unreleased. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| > Part of the [dspack ecosystem](https://github.com/aestheticfunction) — the organization profile has the full map of how the repositories fit together. | ||
| > | ||
| > **Kind:** application (MCP server, npm `@aestheticfunction/ds-mcp`, bin `ds-mcp`) · **Audience:** people using AI coding agents against a design system, and MCP client authors · **Neighbors:** implements the [dspack](https://github.com/aestheticfunction/dspack) spec; vendors its generation core from [dspack-gen](https://github.com/aestheticfunction/dspack-gen); bootstrap a contract with [dspack-export](https://github.com/aestheticfunction/dspack-export); see the full chain running in [dspack-studio](https://github.com/aestheticfunction/dspack-studio) ([hosted replay](https://studio.aesthetic-function.com)) |
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-1 (Truth & Wayfinding) — ds-mcp leg. Per the accepted RFC (dspack rfc/dx-adoption-review.md §1, §6 DX-1):
docs/README.mdsaid "seven read-only tools" while the main README anddocs/architecture.mdsay eleven, with divergent input descriptions. The stale table is replaced by a pointer to the main README's table — single-sourced so the documents cannot disagree again.examples/shadcn-ui.dspack.json(v0.1) →examples/shadcn-ui-v01.dspack.json. Dependent inventory before renaming: README example links,docs/demo-shadcn.md,docs/pre-merge-checklist.md,scripts/smoke.sh, test-file comments (which reference the dspack repo's file — unchanged), and a cross-repo grep of all six siblings (zero external references to the old path). All in-repo dependents updated in the same commit;smoke.shnow exercises the tracked v0.4 synced example; deprecation recorded in README + CHANGELOG (Unreleased). Invariant achieved: no unversioned filename resolves to incompatible contract versions across repos.Verified:
npm test94/94;scripts/smoke.shfull pass (initialize, 11 tools listed, component query). Docs + example rename only — no published-package behavior changes, no DX-2 work.🤖 Generated with Claude Code