Skip to content

Add v0.1 spec draft, JSON Schema, and shadcn/ui example#1

Merged
ryandmonk merged 1 commit into
mainfrom
v0.1-spec-draft
May 21, 2026
Merged

Add v0.1 spec draft, JSON Schema, and shadcn/ui example#1
ryandmonk merged 1 commit into
mainfrom
v0.1-spec-draft

Conversation

@ryandmonk
Copy link
Copy Markdown
Contributor

Summary

Delivers the first three repo-local roadmap milestones, turning the repository from placeholder scaffolding into a first usable spec package.

  • spec/dspack-v0.1.md — v0.1 specification draft defining document structure, tokens, components, patterns, anti-patterns, framework bindings, extensibility (x- prefix convention), ID conventions, and 5 documented open questions
  • schema/dspack.v0.1.schema.json — JSON Schema (draft 2020-12) with $defs for all reusable structures, enforcing required fields, type constraints, and ID naming patterns
  • examples/shadcn-ui.dspack.json — shadcn/ui reference example with 21 tokens (3 categories), 7 components, 3 patterns, 3 anti-patterns, and React framework bindings
  • Minimal README updates pointing to the new artifacts and marking roadmap milestones as draft-available
  • RFC guidance tightened to reference v0.1 for compatibility considerations

Key design decisions

Decision Rationale
Only dspack + name required Real systems are partial; optional sections support incremental adoption
Tokens carry resolved values dspack is a snapshot, not a build pipeline
Framework bindings at top level Keeps component definitions framework-agnostic (stated design goal)
Relationships via ID references Conservative scope; sufficient for v0.1 query patterns
x- prefix for extensions Well-established convention (OpenAPI); prevents future field collision
reason required on anti-patterns A prohibition without context isn't useful

Validation performed

  • Example validates against schema (Python jsonschema)
  • Minimal valid document validates
  • Schema correctly rejects: missing name, missing dspack, wrong version, anti-pattern missing reason, component missing description, uppercase component ID

Remaining follow-up items (later milestones)

  • ds-mcp v0 release — validate spec against reference implementation
  • Community RFCs — process is in place, awaiting proposals
  • v1.0 stabilization — resolve the 5 open questions in spec section 14
  • Additional examples beyond shadcn/ui
  • CI-based schema validation

🤖 Generated with Claude Code

Delivers the first three repo-local roadmap milestones:

- spec/dspack-v0.1.md: v0.1 specification defining document structure,
  tokens, components, patterns, anti-patterns, framework bindings,
  extensibility model, ID conventions, and open questions.
- schema/dspack.v0.1.schema.json: JSON Schema (draft 2020-12) validating
  all spec-defined structures.
- examples/shadcn-ui.dspack.json: reference example exercising all five
  concepts with React framework bindings.

Updates README status banner and roadmap, and points directory READMEs
at the new artifacts. Tightens RFC guidance to reference v0.1 for
compatibility considerations.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 21, 2026 04:57
@ryandmonk ryandmonk merged commit 9644d93 into main May 21, 2026
1 check failed
@ryandmonk ryandmonk deleted the v0.1-spec-draft branch May 21, 2026 04:59
@ryandmonk ryandmonk review requested due to automatic review settings May 21, 2026 05:17
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