docs(DX-1): breadcrumb + charter, reach emit/studio, current export description#26
Merged
Merged
Conversation
…t, examples README counts - README: breadcrumb to the org overview and a kind/audience/neighbors charter; the Consuming section now reaches dspack-gen, dspack-emit, and dspack-studio (with the hosted replay URL) — the spec repo previously linked neither the emitter nor the flagship (D3, RFC Sec 1). - README: dspack-export description catches up to Vue 3 + Vuetify 3 support and DTCG token import (D3). - examples/README: astryx slice counts were stale after the studio governance sync (#22): 9->12 components, 6->14 rules; note the @astryxdesign npm scope alongside the facebook/astryx repo (D5). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the repository documentation to support DX-1 “Truth & Wayfinding” by adding ecosystem wayfinding (breadcrumb/charter) and refreshing documentation references to adjacent tools (gen/emit/studio) plus an updated dspack-export description and example catalog metadata.
Changes:
- Add an above-the-fold breadcrumb and “kind/audience/neighbors” charter to the root README for ecosystem navigation.
- Expand the “Consuming dspack files” section to include dspack-gen, dspack-emit, and dspack-studio, including a hosted replay link.
- Update docs describing dspack-export capabilities and refresh Astryx example counts/sourcing details in
examples/README.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds ecosystem charter/links; updates dspack-export description; adds gen/emit/studio references. |
| examples/README.md | Updates Astryx example description (counts, provenance, npm scope note). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Producing dspack files | ||
|
|
||
| [dspack-export](https://github.com/aestheticfunction/dspack-export) (experimental) generates a dspack v0.2 file from a React + Tailwind/shadcn codebase: components and props (including cva variant enums and their defaults), semantic color and radius tokens from CSS custom properties, dark-theme overrides, layout breakpoints, and React import bindings. It is a snapshot generator. Hand-authored sections such as `patterns`, `antiPatterns`, `whenToUse`, `accessibility`, and `constraints` remain yours to write; an exporter can extract facts, but the institutional knowledge that makes a dspack file valuable to agents comes from your team. | ||
| [dspack-export](https://github.com/aestheticfunction/dspack-export) (experimental) generates a dspack v0.2 file from a React + Tailwind/shadcn or Vue 3 + Vuetify 3 codebase: components and props (including cva variant enums and their defaults, and Vue `defineProps`/emits/slots), semantic color and radius tokens from CSS custom properties or an imported DTCG design-token file, dark-theme overrides, layout breakpoints, and framework import bindings. It is a snapshot generator. Hand-authored sections such as `patterns`, `antiPatterns`, `whenToUse`, `accessibility`, and `constraints` remain yours to write; an exporter can extract facts, but the institutional knowledge that makes a dspack file valuable to agents comes from your team. |
|
|
||
| - [`shadcn-ui.dspack.json`](./shadcn-ui.dspack.json) — a reference dspack file for the [shadcn/ui](https://ui.shadcn.com) component library | ||
| - [`astryx.dspack.json`](./astryx.dspack.json) — a governed slice of Meta's [Astryx](https://github.com/facebook/astryx) design system (pinned v0.1.4): 9 components, categories mirroring Astryx's own docs taxonomy, and 6 rules converted from the repository's structured `*.doc.mjs` guidance, each with a provenance link (`x-source`). Notable: Astryx components are props-based (labels are required string props; tables and menus are data-driven array props) — a deliberately different idiom from shadcn's compound composition | ||
| - [`astryx.dspack.json`](./astryx.dspack.json) — a governed slice of Meta's [Astryx](https://github.com/facebook/astryx) design system (pinned v0.1.4; published on npm under the `@astryxdesign` scope): 12 components, categories mirroring Astryx's own docs taxonomy, and 14 rules converted from the repository's structured `*.doc.mjs` guidance and the studio's example-expansion governance, each rule with a provenance link (`x-source`). Notable: Astryx components are props-based (labels are required string props; tables and menus are data-driven array props) — a deliberately different idiom from shadcn's compound composition |
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) — dspack leg. Per the accepted RFC (rfc/dx-adoption-review.md §1, §6 DX-1):
Docs only. No DX-2 or bootstrap work.
🤖 Generated with Claude Code