Files
typewriter/docs
Julien Calixte 2215da939d feat: add multi-file buffer foundation (v0.5 slice 1)
Rework the single Effect return into a drained effect queue
(Save{path,scope,contents} / Load / Publish / Pull) so one action can
ask the host for several ordered steps: opening a non-resident file
queues a Save of the outgoing dirty buffer then a Load of the target.

Keep the active buffer's fields inline on Editor and park inactive
buffers in a small LRU (<=3 resident = active + 2); switching back to a
resident buffer restores its caret/scroll/undo without touching the SD.
A dirty parked buffer is saved before eviction, so nothing leaves RAM
unsaved. `:e <path>` opens by prefix (/sd/repo -> Tracked, /sd/local ->
Local); `:sync` is refused in-core for a Local buffer.

Firmware drains the queue to empty each batch (a Load can cascade an
eviction Save) and persistence generalises the atomic save off the
hard-coded notes.md into load_path/save_path.

Also bump the side panel to FONT_9X15 and the `:` command line to
FONT_10X20 for legibility, word-wrapping the snackbar so a long notice
keeps its actionable tail.
2026-07-11 22:26:37 +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.
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.