Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

The specification

The normative text behind every page of this site lives in the corpus, as spec entities, and not here. A page explains and links; a spec states the rule, and where the two disagree the spec is right and the page is a bug (ADR-33970fcdb6e8). They argue the design; they are not a tutorial.

Each one says in its own body which sections of the original single document it carries, so a rule that reads (§7) is resolved by the spec that claims §7. In a checkout, ank find --type spec lists them and ank show <id> prints one whole. On the web, each link below opens the file as the default branch has it.

The list is every spec the corpus holds as accepted, and a test holds it to ank find --type spec on this repository: a spec accepted, superseded or retitled without this page following turns the suite red. A superseded spec is left off, and ank show still prints it, with the one that replaced it named.

Linked, not rendered. The specs are read here through GitHub’s view of the file rather than copied into the site at build time. A rendered copy would need the site’s build to run ank, and would be one more place the text could be read out of step with the corpus it came from; the link always reaches the default branch’s bytes.