Files
typewriter/docs
Julien Calixte 9309f3f239 docs(sync): record the esp_map v2 verdict and cache removal
Run 4: memory discipline verified (1833 KB flat, no OOM) but 0 hits
with the small maps demonstrably retained — window-repetition theory
refuted, sub-second bar failed (splice 2.83 s cold / ~2 s steady).
Decision: wire the splice in anyway (~9-10 s cold real-repo :sync vs
611 s/OOM for every alternative). Run 5: cache removal confirmed
free; the ~1.85 MB "resident" was mwindow's live window set, which
makes the mwindow opts in shipping git_sync.rs load-bearing.
2026-07-13 00:20:12 +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.
macroplan.md Version-by-version plan; each release is a usable artifact, not a checkpoint.
typoena-toml.md .typoena.toml reference — the git-tracked editor preferences (auto-save, format-on-save, line numbers, auto-sync).
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; §3 is the filled 14 WHATs × 14 HOWs House of Quality.
quality-house-empty.md The House 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 — e.g. where the ~16 s cold :sync goes.
tradeoff-curves/ Cost-vs-knob curves behind chosen defaults — energy, latency, memory.