WORK-637
ID:WORK-637Status:ready

The authoring guide for composed runes

Composition ships to users in this milestone, and SPEC-153 D9 makes the definition file the user-facing authoring surface. Today the only documentation is a PluginRune note in rune-authoring/authoring-overview.md. Add a page under site/content/extend/rune-authoring/ written from SPEC-145's "template vocabulary, in one place" table. The guide is the spine of that table rather than a summary of it.

It covers:

Priority:highComplexity:moderateMilestone:v0.41.0Source:SPEC-145,SPEC-153
changeset-release/main View source

Criteria completion

Criteria completion: 0 of 6 (0%) checked; tracking started on Oct 8, no incremental history yet0%25%50%75%100%Oct 8Oct 11

Tracking started Oct 8 — check back for trends.

Relationships

Implements 2
Related 3
Branches 3
changeset-release/main current ready
claude/post-v0.38-roadmap-jb7pie readymain doneclaude/v041-composed-runes-guide done
History 2
  1. f5d1e00
    Created (ready)by github-actions[bot]
  2. fad3ced
    Content editedby Claude
    plan: draft v0.41.0 — Composed runes you can ship

Blocked by

  • WORK-633
  • WORK-634

Acceptance Criteria

  • A composed-runes page exists under site/content/extend/rune-authoring/, linked from the overview, covering the file format, the full vocabulary, the placeable set and where definitions go
  • The authoring guide states the placeable set as one list — the intersection of the no-peer-schema and no-required-parent exclusions — not as two rules to combine (SPEC-145 D12)
  • The authoring guide states the project-versus-package asymmetry with the reason rather than as a convention (SPEC-153)
  • Every construction-time error message the compiler can produce is listed with its cause and fix, and a test fails if a new error is added without a docs entry
  • The worked examples are included from the tested fixture files, so the docs cannot drift from definitions that are proved to build
  • refrakt validate passes on the new page, and refrakt.stale reports no page pointing at the changed paths without review