docs: reframe README opening around governance; bump harness to 0.4.0#18
Merged
Conversation
The opening sentence still described dspack as the v0.2-era corpus
("what a design system knows: tokens, components, patterns, and
anti-patterns"). Since v0.3/v0.4 the contract also carries categories,
intents, and typed governance rules, and the org description leads with
that framing. Reword the opening to match; the "OpenAPI for design
systems" line and the status block are unchanged.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The spec draft is at v0.4 and the harness validates v0.4 artifacts, but the package stayed at 0.3.0. Bump to 0.4.0 so the harness version tracks the spec version it validates. Safe: the package is "private": true and unpublished (no npm history to break). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repository’s public-facing framing to reflect the v0.4 governance-oriented contract, and aligns the local validation harness version with the spec draft it validates.
Changes:
- Reframes the README opening to emphasize categories, intents, and typed governance rules.
- Bumps the (private) validation harness version from 0.3.0 to 0.4.0.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Updates the opening description to reflect v0.4 governance concepts (categories/intents/rules). |
| package.json | Bumps harness version to track the v0.4 spec draft validated by this repo. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # dspack | ||
|
|
||
| **dspack** is an open JSON specification for representing what a design system knows: tokens, components, patterns, and anti-patterns in one portable artifact that AI agents can query. | ||
| **dspack** is an open JSON specification for what a design system knows and enforces: tokens, components, categories, intents, and typed governance rules in one portable contract that AI agents can query and must satisfy. |
| { | ||
| "name": "@aestheticfunction/dspack-spec", | ||
| "version": "0.3.0", | ||
| "version": "0.4.0", |
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.
Two independent commits.
1. README opening reframed around governance (
README.md:3)The opening still described the v0.2-era corpus ("what a design system knows: tokens, components, patterns, and anti-patterns"). Since v0.3/v0.4 the contract also carries categories, intents, and typed governance rules, which is how the org description leads. New sentence:
The "OpenAPI for design systems" line and the status block are unchanged.
2. Harness version bump 0.3.0 → 0.4.0 (
package.json:3) — previously-flagged ambiguous itemDecision: bump so the harness version tracks the spec draft it validates. Safe because the package is
"private": trueand unpublished (npm view→ 404), so there is no published history to break. Isolated in its own commit — drop it if you'd rather the harness version independently of the spec.Verification
npm run validate— schema-compile PASS (5 schemas), both examples validate as dspack 0.4.🤖 Generated with Claude Code