chore: refresh registry metadata and docs
This commit is contained in:
+46
-3
@@ -1,4 +1,4 @@
|
||||
# AI UI Roadmap
|
||||
# Cadence UI Roadmap
|
||||
|
||||
## Goal
|
||||
|
||||
@@ -7,7 +7,22 @@ Build a long-term maintainable component system inspired by `shadcn/ui`, but own
|
||||
- keep the `Radix + Tailwind + source-owned components` model
|
||||
- replace default styling with our own tokens and component rules
|
||||
- make motion a first-class system layer, not ad hoc transitions
|
||||
- support theming, accessibility, testing, and future internal registry distribution
|
||||
- support theming, accessibility, testing, and internal registry distribution
|
||||
|
||||
## Status Snapshot
|
||||
|
||||
This document began as the build-out plan for the system. The current repo has already
|
||||
completed most of that baseline work:
|
||||
|
||||
- phases 0 through 4 are effectively in place: workspace, tokens, authoring contract, core components, Storybook docs, and baseline tests
|
||||
- phase 5 has shipped its first advanced-pattern slice with `DataTable`, alongside `Command`, `Combobox`, `Sheet`, and `EmptyState`
|
||||
- phase 6 has shipped its baseline source-copy registry flow, Changesets gating, and version PR automation
|
||||
|
||||
The next work is mostly hardening and distribution:
|
||||
|
||||
- keep the registry metadata and consumer smoke flow reliable
|
||||
- decide publish and tagging policy
|
||||
- expand advanced patterns only where real product usage justifies them
|
||||
|
||||
## Product Principles
|
||||
|
||||
@@ -70,7 +85,7 @@ packages/
|
||||
tokens/ # design + motion tokens
|
||||
icons/ # optional icon wrappers
|
||||
config/ # shared ts/eslint/tailwind config, optional
|
||||
registry/ # future internal shadcn-like registry
|
||||
registry/ # internal source-copy registry
|
||||
```
|
||||
|
||||
### `packages/ui` structure
|
||||
@@ -319,6 +334,9 @@ Exit criteria:
|
||||
|
||||
## Phase 5: Advanced Patterns
|
||||
|
||||
Status:
|
||||
Baseline shipped.
|
||||
|
||||
Objective:
|
||||
Build higher-level patterns only after the base layer is stable.
|
||||
|
||||
@@ -333,6 +351,15 @@ Candidate patterns:
|
||||
- `Sheet`
|
||||
- `Empty State`
|
||||
|
||||
Current shipped patterns:
|
||||
|
||||
- `Form`
|
||||
- `Data Table`
|
||||
- `Command`
|
||||
- `Combobox`
|
||||
- `Sheet`
|
||||
- `Empty State`
|
||||
|
||||
Exit criteria:
|
||||
|
||||
- patterns reuse existing component contracts
|
||||
@@ -340,6 +367,9 @@ Exit criteria:
|
||||
|
||||
## Phase 6: Internal Registry and Distribution
|
||||
|
||||
Status:
|
||||
Baseline source-copy distribution is shipped. Publish automation is still open.
|
||||
|
||||
Objective:
|
||||
Create an internal distribution model similar to `shadcn`, but based on our own rules.
|
||||
|
||||
@@ -350,6 +380,19 @@ Deliverables:
|
||||
- documentation for install and upgrade paths
|
||||
- versioning and release process
|
||||
|
||||
Delivered so far:
|
||||
|
||||
- generated `registry/index.json`
|
||||
- local `pnpm registry:install` copy-in workflow
|
||||
- `pnpm test:registry:consumer` validation
|
||||
- Changesets status checks and version PR automation
|
||||
|
||||
Remaining follow-up:
|
||||
|
||||
- publish decision and package registry posture
|
||||
- tagging policy for stable install points
|
||||
- any automation beyond source-copy installs
|
||||
|
||||
Exit criteria:
|
||||
|
||||
- consumers can pull components from our registry
|
||||
|
||||
Reference in New Issue
Block a user