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

docs(readme): link GLOSSARY.md from intro and repo layout

Browse Source 
GLOSSARY.md was reachable only via docs/qfd.md's §2 preamble.
Surfacing it from README adds two entry points: the intro and
software-stack pointers to docs/qfd.md now follow up with a link
to GLOSSARY.md (the ontology layers used across the docs), and
the repo-layout block lists GLOSSARY.md alongside CONTEXT.md so
the two glossaries' division of labour — device vocab vs
methodology vocab — is visible at a glance.
This commit is contained in:
Julien Calixte
2026-05-19 14:51:29 +02:00
parent 6dff2315c8
commit 1c6dfec7e6
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -6,7 +6,7 @@ runs on it.
> Status: pre-MVP. Hardware not yet on bench. Bring-up in progress.
How each decision is weighted against the user-facing requirements — and the critical performance budget that falls out — lives in [`docs/qfd.md`](docs/qfd.md).
How each decision is weighted against the user-facing requirements — and the critical performance budget that falls out — lives in [`docs/qfd.md`](docs/qfd.md). The ontology layers those docs use (WHAT / Function / Characteristic / Metric / Target) are defined in [`GLOSSARY.md`](GLOSSARY.md).
---
@@ -58,7 +58,9 @@ rejected alternatives below, and [`docs/adr.md`](docs/adr.md) for the full
decision log covering language, UI strategy, display, git lib, auth,
concurrency, storage, power, and keyboard transport. How each decision is
weighted against the user-facing requirements — and the critical performance
budget that falls out — lives in [`docs/qfd.md`](docs/qfd.md).
budget that falls out — lives in [`docs/qfd.md`](docs/qfd.md). The ontology
layers those docs use (WHAT / Function / Characteristic / Metric / Target)
are defined in [`GLOSSARY.md`](GLOSSARY.md).
| Layer | Crate / Component | Notes |
| ---------------- | -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -173,6 +175,8 @@ gantt
/docs ADRs, QFD, roadmap, per-version product + technical specs
CONTEXT.md project glossary — Tracked / Local / Save / Publish, and the
principles that fall out of them
GLOSSARY.md methodology glossary — the WHAT / Function / Characteristic /
Metric / Target ontology layers used across docs
package.json pnpm + oxfmt — formatting toolchain for docs/JSON
(companions: pnpm-lock.yaml, .oxfmtrc.json, .node-version)
```