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

Architecture decision records

Short records of decisions that shape the code, with their context and the alternatives we rejected. New ADRs are numbered sequentially and never renumbered; a decision that changes gets a new ADR that supersedes the old one.

ADRTitleStatus
0001MIT OR Apache-2.0, clean-room from Ink/StitchAccepted (decision 2 replaced by 0012)
0002Host-agnostic engine; VectorCraft ABI v1 plug-in firstAccepted
0003One parameter registry generates everythingAccepted
0004Determinism by constructionAccepted
0005Geometry stackAccepted (spike M0.7)
0006mdBook, Diátaxis, generated reference, CI-regenerated imagesAccepted
0007PES v1 first, for the Brother 200 × 200 mm machineAccepted (decisions 2 and 3 replaced by 0013)
0008Conformance-first developmentAccepted
0009Adopt VectorCraft’s conventions; improve the ones that driftAccepted
0010Coded diagnostics with explanation pagesAccepted
0011StitchCraft can move into VectorCraft’s repositoryAccepted
0012Read Ink/Stitch’s source, never copy itAccepted
0013The reference machine is a Brother PE800, with a profile for each of its hoopsAccepted
0014Generators see their neighbours: the needle before, the next element afterAccepted

cargo xtask docs --check fails if an ADR file is missing from this table or its status here differs from the file’s status line.