julien/typewriter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add CONTEXT.md glossary and cross-link from README + ADR log

Browse Source 
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.
This commit is contained in:
Julien Calixte
2026-05-14 20:37:43 +02:00
parent ae555e40a4
commit 668478aa40
3 changed files with 118 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/adr.md
View File

@@ -9,6 +9,9 @@ Format inspired by Michael Nygard's ADR template, kept short on purpose.
**Related docs:**
[`../README.md`](../README.md) — project overview, hardware table, macro plan.
[`../CONTEXT.md`](../CONTEXT.md) — project glossary: **Tracked**, **Local**,
**Save**, **Publish**, plus the principles ("writing tool, not sync engine")
that constrain ADR-010 specifically.
[`roadmap.md`](roadmap.md) — per-version scope (v0.1 → v1.x).
[`v0.1-mvp-product.md`](v0.1-mvp-product.md) — what the v0.1 device must do.
[`v0.1-mvp-technical.md`](v0.1-mvp-technical.md) — how v0.1 is built.