Commit Graph

12 Commits

Author SHA1 Message Date
Julien Calixte
a63d2fcb1e docs(adr): reframe ADR-003 as display medium decision
The old ADR documented the specific panel choice (GDEY0579T93 + DESPI-c579)
as if it were a freshly weighed option, but the hardware was already on
hand — the real architectural decision was choosing the medium (e-ink over
FSTN graphical / Sharp Memory LCD / OLED-TFT). Rewrite the ADR around the
medium with the panel as instantiation, note the Freewrite Alpha (2023)
data point as honest expectation-setting, and propagate the anchor /
narrative changes through qfd.md, v0.1-mvp-product.md, and README.md.
2026-05-14 21:49:01 +02:00
Julien Calixte
7055d01e9d docs: refresh v0.1 spec for gct publish flow and dev-only build-time config
Two coupled changes that emerged from one /deep-design session, both touching
the same v0.1 paragraphs:

(1) Align Ctrl-G with the user's existing gct shell alias: git add . ->
    short-circuit if nothing staged -> commit with an ISO-8601 timestamp (no
    wip prefix) -> push -> on push failure, git pull --no-edit then retry.
    Atomic from the user's view. Recorded as ADR-010. The previously-planned
    v0.7 commit-message-prompt item is removed; it contradicts the
    gct/timestamp model.

(2) Replace the v0.1 captive-portal first-run with build-time env-var
    config: build.rs reads TW_* env vars and embeds them as constants. No
    NVS read, no LittleFS mount, no AP mode, no HTTP server. The v0.1
    target user is the dev themselves; the first release usable by non-dev
    users is v0.9, and the v0.9 settings entry is reframed accordingly.
    ADR-005 updated to describe the build-time path and the v0.9 migration.

The two changes share files because the v0.1 spec is one interlocked
document; splitting further would require line-level surgery without
improving auditability.
2026-05-14 20:40:09 +02:00
Julien Calixte
668478aa40 docs: add CONTEXT.md glossary and cross-link from README + ADR log
CONTEXT.md fixes the project's user-facing vocabulary (Tracked, Local,
Save, Publish) and the principles that fall out of those definitions
(the device is a writing tool, not a sync engine; it does no git work
the user did not explicitly request). README's file-scopes section and
repo-layout listing point at the new glossary so a first-time reader
lands on canonical definitions, and the ADR log carries an inbound link
so future ADRs can rely on the same terms.
2026-05-14 20:37:43 +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
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
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
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