diff --git a/packages/pretui/README.md b/packages/pretui/README.md index dce349004ca..b9f134e47e1 100644 --- a/packages/pretui/README.md +++ b/packages/pretui/README.md @@ -37,7 +37,7 @@ Every component's ` ; diff --git a/packages/pretui/components/freestyle-usage.md b/packages/pretui/components/freestyle-usage.md index 96bfc245406..c7145b7aff9 100644 --- a/packages/pretui/components/freestyle-usage.md +++ b/packages/pretui/components/freestyle-usage.md @@ -1,6 +1,6 @@ ## What it is -The usage page: a component's example, its interactive knobs, its API table and its source, in one frame. Use it to document a component. Every page in the Pretui catalogue is one of these. If you only need the artboard frame, **Viewport**; if you need the theme switcher, **ThemeFrame**. +The usage page: a component's example, its interactive knobs, its API table and its source, in one frame. Use it to document a component. Every page in the Pret UI catalog is one of these. If you only need the artboard frame, **Viewport**; if you need the theme switcher, **ThemeFrame**. ## The contract @@ -24,7 +24,7 @@ Where the Pretui port differs, and each is a deliberate delta: - **The machinery wears the kit.** **Select**, **Input**, **Switch** and **Slider** are the knob controls; **Table** renders the API docs; **Viewport** frames every example. So the documentation surface dogfoods the components it documents — a broken Select breaks its own usage page, which is a useful forcing function Storybook's React-based panel does not have. - **The dual-lens `<:api>`** (above). Storybook derives its controls table from types; freestyle makes you author knobs; this makes you author once and renders both. - **No ember-freestyle service.** The upstream keeps a global service for section registration; this is component-local, which suits a realm where a page is a card. -- **Plain `
` for `@source`.** No syntax highlighter — Law 9 forbids vendoring one, and the trade is stated rather than hidden.
+- **Plain `` for `@source`.** No syntax highlighter — Law 9 forbids vendoring one, and the trade is stated rather than hidden.
 - **Labeled controls**, where upstream's are bare.
 
 Where it is behind Storybook, honestly: no addons, no interaction testing, no accessibility panel, no visual regression, and no auto-generated argTypes.
@@ -35,17 +35,15 @@ No pattern governs it; it is a page composed of the kit's own components, and it
 
 Gaps worth knowing, because a documentation surface is read by exactly the people who care about these:
 
-- **The page's regions have no landmark or heading structure of their own.** Description, example, knobs, API table and source are four or five regions with no `role`, no `aria-label` and — verify — possibly no headings. A screen-reader user cannot jump between "the example" and "the API table". For a docs page that is the single most useful thing to add.
-- **`@name` is not necessarily a heading**, and if it is, its level is fixed — the kit-wide problem (**Panel**, **Toolbar**, **EmptyState**, **Stat**, **FittedCard** all share it).
+- **Only part of the page has heading structure.** Properties, API and CSS Variables are headed by `h2`s, so heading navigation reaches the knobs and the tables; Properties is an `