From 1c6dfec7e603b98052ddf59ae41abcb4e5193f1d Mon Sep 17 00:00:00 2001 From: Julien Calixte Date: Tue, 19 May 2026 14:51:29 +0200 Subject: [PATCH] docs(readme): link GLOSSARY.md from intro and repo layout MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ffd25ff..8b69e6f 100644 --- a/README.md +++ b/README.md @@ -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) ```