Files
typewriter/docs
Julien Calixte 4bc9236bd7 docs(adr): record ADR-012 — SD on its own SPI3 host
Document the shared-bus arbitration decision: rather than rework the
proven EPD SPI layer and add a cross-thread mutex on the save path, the
SD moves to a dedicated SPI3. Update the boot sequence, risk table,
Spike 3 postmortem follow-up, hardware overview, and firmware README.
2026-07-11 11:28:22 +02:00
..

Docs

The design record for Typoena — the decisions, specs, and bench write-ups behind the writing appliance. Start with the ADRs for the load-bearing choices, or the v0.1 specs for what the first release actually does.

Project overview: ../README.md.

Decisions & specs

Doc What's in it
adr.md Architecture Decision Records — the load-bearing technical choices and why.
v0.1-mvp-product.md v0.1 product design — boot, type one file, Ctrl-S to save, Ctrl-G to publish.
v0.1-mvp-technical.md v0.1 technical design — single Rust binary on esp-idf-rs, modules, threads, bring-up order.
roadmap.md Version-by-version plan; each release is a usable artifact, not a checkpoint.
hardware.md Part choices for the bench build and the rationale behind them.

Quality method

Doc What's in it
qfd.md Quality Function Deployment — turns user-facing requirements into technical HOWs.
quality-house.md The 14 WHATs × 14 HOWs House of Quality, filled in.
quality-house-empty.md The same chassis, blank — for re-scoring from scratch.

Bench work

Area What's in it
spikes.md Rendering & UX spikes — display/UX risks proved outside the hardware stack.
postmortems/ Bring-up debugging write-ups: what broke, the root cause, and the decisions that came out of it.
notes/ Longer-form essays on the thinking behind specific choices.