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.
- SPEC-3d417b8d8d91 Intent, principles, and what v1 leaves out
- SPEC-ed5f09df66ef The data model
- SPEC-3252ad5a72e3 Storage and search
- SPEC-43a2bcb939e3 Synchronisation
- SPEC-ff885356f1f9 Proof, anchoring and authority
- SPEC-79012ba18769 The CLI surface
- SPEC-558c07ebae8e Presentation: structure for every reader, colour for a terminal, and an identifier by its kind
- SPEC-a1234da5449a The attention budget and the constraint lifecycle
- SPEC-f0eef72fe74d Bootstrapping, teaching and distribution
- SPEC-e8518a6aab5c Implementation, and the decisions that bound 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.