Reorganize repo structure and standards references
This commit is contained in:
1 parent
3cb93a81be
commit
be2054274d
5885 files changed
+2588
-195
No files matched your search
@@ -0,0 +1,32 @@
|
||||
import { Meta } from "@storybook/blocks";
|
||||
|
||||
<Meta title="welcome/introduction" />
|
||||
|
||||
# Toolctrl UI — Storybook
|
||||
|
||||
This Storybook aggregates components from the four UI packages of the
|
||||
boilerplate:
|
||||
|
||||
| Package | Layer | Notes |
|
||||
| --- | --- | --- |
|
||||
| `@toolctrl/ui` | base primitives | shadcn / radix wrappers |
|
||||
| `@toolctrl/ui-app` | composites | tenant-app shell pieces |
|
||||
| `@toolctrl/ui-subframe` | designer output | Subframe-generated components |
|
||||
| `@toolctrl/ui-mock` | fixtures | mock pages + sample data for hot-swap drills |
|
||||
|
||||
Use the sidebar to browse component stories. Each story exposes its props as
|
||||
Controls and runs an **a11y check** via `@storybook/addon-a11y`.
|
||||
|
||||
## Conventions
|
||||
|
||||
- **CSF-3** — every story file exports a default `Meta` plus named story
|
||||
objects.
|
||||
- **Co-located** — stories live next to the source in
|
||||
`packages/<pkg>/src/stories/`.
|
||||
- **Pure renders** — stories should not depend on the running web app; pull
|
||||
fixtures from `@toolctrl/ui-mock` when needed.
|
||||
- **A11y** — violations fail the story; opt-out with
|
||||
`parameters: { a11y: { disable: true } }` plus a code comment explaining
|
||||
why.
|
||||
|
||||
See `docs/architecture/storybook.md` for the full author guide.
|
||||
Reference in new issue
Block a user