Commit Graph

23 Commits

Author SHA1 Message Date
Julien Calixte
a233798431 2026-05-14 13:15:47 2026-05-14 13:15:47 +02:00
Julien Calixte
00c1f7ced4 chore(zed): add project settings with oxc and oxfmt format-on-save 2026-05-14 13:08:09 +02:00
Julien Calixte
a399d06864 style(docs): apply oxfmt to README and v0.1 docs
Aligns markdown table columns and converts *emphasis* to _emphasis_.
No content changes.
2026-05-14 12:56:13 +02:00
Julien Calixte
23ccd5d43e chore: add oxfmt fmt and fmt:check scripts 2026-05-14 12:56:07 +02:00
Julien Calixte
4eefd2c244 docs(qfd): convert requirement sources to clickable cross-references
The customer-requirements (WHATs) Source column was plain text ("product
§UX", "README v0.8"). Replace with anchored Markdown links into the
product spec, README, and roadmap so each requirement's provenance is
one click away.
2026-05-14 12:50:50 +02:00
Julien Calixte
04a323da1c docs(v0.1): link technical risk register to qfd unresolved-conflicts section 2026-05-14 12:50:34 +02:00
Julien Calixte
90e98d2375 docs(v0.1): cross-link technical doc to ADRs and qfd
Adds a companion-docs header and inline ADR jumps on every load-bearing
choice (ADR-001 runtime, ADR-002 UI, ADR-004 git kill-switch, ADR-006
concurrency, ADR-007 storage, ADR-009 USB-host gate). Render module
also points at qfd §3 to anchor "why these functions rank top."
2026-05-14 12:50:12 +02:00
Julien Calixte
2a2c268010 docs(v0.1): cross-link product spec to companion docs and ADRs
Adds a "Companion docs" header (README, technical, ADR, QFD, roadmap)
and inline pointers from the auth section to ADR-005, the screen
layout to ADR-003, and the acceptance criteria block to qfd §6 — so
each "what must this do" claim has a one-click jump to its rationale
or target.
2026-05-14 12:49:52 +02:00
Julien Calixte
05f87efea4 docs(adr): cross-link ADR-007/008/009 to v0.1 docs and roadmap
Adds inline pointers from ADR-007 (storage) to the v0.1 technical
persistence + file-layout sections, from ADR-008 (power) to the v0.1
out-of-scope and roadmap v0.8, and from ADR-009 (keyboard) to spike 4
in the v0.1 technical bring-up order.
2026-05-14 12:49:47 +02:00
Julien Calixte
baf1407785 docs(readme): link software stack section to qfd.md 2026-05-14 12:49:17 +02:00
Julien Calixte
f44da5892a docs(readme): list pnpm + oxfmt toolchain in repo layout 2026-05-14 12:49:04 +02:00
Julien Calixte
efc694eb9b docs(adr): cross-link ADRs to README, roadmap, qfd, and v0.1 docs
Adds a "Related docs" header at the top of adr.md and inline "See also"
pointers from ADR-001 (binary/build tradeoffs → qfd §7) and ADR-002
(render module → v0.1 technical, top H1/H2 functions → qfd §3). Makes
the design-doc set walkable instead of a flat list.
2026-05-14 12:48:45 +02:00
Julien Calixte
e1e456e02d docs(roadmap): add Mermaid Gantt and split version detail into roadmap.md
Macro-plan dates start 2026-06-01 with `after` dependencies between
versions. Per-version checklists move to docs/roadmap.md so the README
stays synthetic.
2026-05-14 12:47:01 +02:00
Julien Calixte
8fb8cce729 docs(qfd): add quality function deployment design doc
Translates user-facing requirements (the WHATs) into engineering
functions (the HOWs) and components, with a House-of-Quality matrix,
roof tradeoffs, function→component mapping (anchored to ADRs), and a
critical performance budget keyed to upcoming spikes. Cross-references
adr.md throughout.
2026-05-14 12:45:18 +02:00
Julien Calixte
56c934e97e docs(adr): correct ADR-006 stack budget to 76 KB
Prior text said "~40 KB of stack space"; the v0.1 technical design's
task table sums to 76 KB (usb 8 + wifi 8 + ui 16 + render 12 + git 32).
Also widens the std::thread stack-cost note from a flat 8 KB to 8–32 KB
to match the per-task budget. No design change — 76 KB still fits
comfortably in the ESP32-S3's 512 KB internal SRAM.
2026-05-14 12:45:12 +02:00
Julien Calixte
0159f7f6bb chore: add remanso writing-tool config 2026-05-14 12:45:05 +02:00
Julien Calixte
8a44ba50a6 chore: add pnpm + oxfmt for repo formatting
Pins Node 24 via .node-version, declares pnpm 10.32.1 as packageManager
in package.json, and adds oxfmt as a dev dependency with .oxfmtrc.json
(single quotes, no semi, 80 cols). Ignores node_modules.
2026-05-14 12:45:01 +02:00
Julien Calixte
3b24a288ca chore: add .gitignore for Rust and esp-idf artifacts 2026-05-14 12:32:31 +02:00
Julien Calixte
08be635659 docs(adr): add architecture decision log for 9 load-bearing choices 2026-05-14 12:27:43 +02:00
Julien Calixte
421270cdf2 docs(hardware): switch display to GDEY0579T93 with DESPI-c579
Strip-aspect 5.79" panel (792×272) replaces the page-shaped 7.5" choice.
Reflows the v0.1 screen layout, framebuffer memory budget, and spike 2
acceptance to validate the SSD1683-class controller path or fall back to
a ~300 LoC custom embedded-hal driver.
2026-05-14 12:27:33 +02:00
Julien Calixte
490e2930e3 docs(v0.1): add MVP product and technical design specs 2026-05-14 11:49:50 +02:00
Julien Calixte
2080fa0602 docs: draft project plan, stack rationale, and release roadmap
Sets language (Rust on esp-idf-rs), rejects Ratatui and Gleam+Shore with
reasons, locks the MVP scope to "write, save, push one file" and defines
nine downstream releases so each ships a usable artifact.
2026-05-14 11:46:20 +02:00
Julien Calixte
54169e248f first commit 2026-05-14 11:31:57 +02:00