V0.49.0
Name:v0.49.0Status:planning

v0.49.0 — Rune docs, simplified

Every rune and docs page is cut back to the reader who opens it (SPEC-193). A rune page is for someone writing content: what the rune is for, how to write it, what it looks like, what can change. Theme and implementation detail, hand-written copies of generated tables, plan IDs and release history leave the pages; examples become live and minimal; the rune nav is regrouped by what the author is doing.

Not enough history yet — burndown needs at least one completed day of activity.

Progress 0/11 work items

Relationships

Related 12
History 1
  1. cf66c86
    Created (planning)by bjornolofandersson

Work Items

Ready 11
WORK-711 main
Rune categories are stated once, regrouped into ten, and the nav follows them
SPEC-193 D9 and D10. A rune's category is written in three places that drift (the rune nav, the page's category: frontmatter, the rune definition's category:), and the rune nav is in no order. The core runes regroup into ten categories by what the author is doing, checked against the primitives the composition specs will add.
high moderate
0/5 criteria
WORK-712 main
A rune page has one shape, and the attribute table renders a rune's family
SPEC-193 D1. Rune pages have no fixed section order, and the attribute table sits under H2, H3 or H4, often nested under the example before it. About 20 pages include the attribute partial once per child rune, and two document only the child.
high moderate
0/5 criteria
WORK-713 main
Output and implementation sections leave the rune pages
SPEC-193 D2. Fifteen rune pages carry an Output contract (HTML dumps, BEM classes, data-* attributes), and about 40 explain CSS, custom properties or pipeline internals to content authors. refrakt inspect and the structure contract state the structure, generated.
medium moderate
0/6 criteria
WORK-714 main
Hand-written attribute tables give way to the generated one
SPEC-193 D3. About 24 pages carry hand-written attribute tables or attribute-by-attribute prose beside the generated table; one (card) already contradicts it, and plan/work and plan/spec end with two orphaned rows.
medium simple
0/5 criteria
WORK-715 main
Published docs cite no plan entities and carry no release history
SPEC-193 D4. The generated attribute table carries 724 plan IDs from the universal-axis descriptions; rune pages, user docs, theme pages and extend cite specs and decision numbers a reader cannot open, and about 26 pages narrate release history.
medium moderate
0/6 criteria
WORK-716 main
Rune pages say how Markdown is read and when to use the rune, in place of the Section header boilerplate
SPEC-193 D6 and D1.2, D1.4. The "Section header" paragraph is repeated on 20 rune pages (twelve with a typo), and almost no page says when to use the rune rather than its neighbour.
medium moderate
0/4 criteria
WORK-717 main
Rune page examples are live, minimal and real
SPEC-193 D5. Fifteen rune pages have no live preview (preview's own page among them), several bury their point in inline sandbox and mockup code, and example content is placeholder or about the engine.
medium complex
0/5 criteria
WORK-718 main
Concept guides move to a Concepts group, and fixtures leave the rune catalogue
SPEC-193 D7. surfaces, media-guests, image-schemes and motion are concept guides in the rune catalogue; plan/examples is a fixture page; plan/cli documents a CLI.
medium simple
0/5 criteria
WORK-719 main
Getting started is rewritten, and the adapter pages share one setup
SPEC-193 D8. Getting started never says npm run dev and contradicts its own scaffold step; the six adapter pages repeat each other across about 2,400 lines.
medium moderate
0/3 criteria
WORK-720 main
Theme pages share a template, each topic has one home, and the docs nav and terms are consistent
SPEC-193 D8. The theme preset pages repeat four sections; configuration migration, tint and the metaFields family are each explained in three places; the docs nav mixes advanced topics into Authoring and leaves pages orphaned.
medium moderate
0/6 criteria
WORK-721 main
The longest rune pages are simplified page by page
SPEC-193's last pass, once the rules above have landed: the pages still too long for their rune are rewritten to the template, one at a time.
low complex
0/2 criteria