Design documents

These pages are the specification StitchCraft is built from. They describe behaviour and algorithms in our own words and never carry Ink/Stitch’s code (ADR-0012).

Reading order

1. Technical design document — the whole system in 25 minutes.
2. Architecture — crates, layers, where code goes.
3. Data model, parameter registry, diagnostics.
4. Engine pipeline, the stitch generators and image to embroidery.
5. Machine formats and rendering previews.
6. VectorCraft integration, the plug-in features RFC and the compatibility gate.
7. Quality: conformance, determinism, guardrails, docs pipeline.
8. File compatibility: SVG input and the Ink/Stitch compatibility contract.
9. Decisions: ADRs.

Keeping these pages true

• A design page changes in the same PR as the behaviour it describes. The comment <!-- implements: … --> below its title names the source files it describes. cargo xtask docs for PATH lists the pages for a file. cargo xtask docs --check fails when a branch changes those files and leaves the page as it was, unless a commit message on the branch says Design-reviewed: <page>.
• Pages cite requirement ids (REQ-…) and diagnostic codes (SC-…); the docs check fails on unknown ids.
• Facts about Ink/Stitch and VectorCraft name the commit they were checked against.