ablative docs
↑↓ move↵ openesc close
Stack Notebook ablative.com.au

Design records

Where the briefs and the lane records live, and how to read them.

Open .md

The briefs

Briefs live under docs/design/<cluster>/briefs/ as a Markdown page and its JSON twin, one id each: NET- for the network, DUR- for durability, CON- for the console, ACCESS- for admission. A brief names its purpose, its task, its requirements as testable sentences, its boundaries and its verification. An amendment is appended, dated, never rewritten over.

The lane records

Each landing’s record names its start and end, the cause at the bytes, the tests that were red first and green after, every file changed, and what was found and not confirmed. The commit message carries the same facts in prose.

How to read them

Start from the commit on main; its message names the brief. The brief’s requirements name the tests; the tests name the bytes. Nothing on these pages says more than a brief and its tests prove.