diff --git a/.cursor/rules/doc_links.mdc b/.cursor/rules/doc_links.mdc index 9ac5522a..8f543c3d 100644 --- a/.cursor/rules/doc_links.mdc +++ b/.cursor/rules/doc_links.mdc @@ -9,8 +9,8 @@ Links to critical files by name for Cursor memory and quick reference. - [Implementation Tasks](docs/implementation.md) - [PRD](docs/PRD.md) - [Project Structure](docs/project_structure.md) -- [Glossary](context/glossary.md) -- [Project Overview](context/project_overview.md) +- [Glossary](docs/README.md#glossary) +- [Project Overview](docs/README.md) - [System Principles](docs/system_principles.md) ## Key Directories diff --git a/.cursor/rules/principles.mdc b/.cursor/rules/principles.mdc index 991f7895..9a5955eb 100644 --- a/.cursor/rules/principles.mdc +++ b/.cursor/rules/principles.mdc @@ -25,6 +25,13 @@ alwaysApply: true - Safety & trust: caret‑safe; private by default; explain choices simply; fail soft. - Logic: smallest context; plain outputs; one thing at a time; validate a small band. - Performance: match the device; ship only what we can test. +<<<<<<< HEAD + - Performance: match the device; ship only what we can test. + +Always check clarifications: +- Consult `docs/questionnaire/questions.md` for live decisions before acting. +======= +>>>>>>> origin/main See `docs/system_principles.md` for links to deeper docs. diff --git a/docs/README.md b/docs/README.md index 207b9ffd..1cbd468a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -46,6 +46,21 @@ - `questionnaire/` - Product questionnaire sections and live `questions.md` (clarifications). Treat as the primary Q&A surface; deprecated `questions-incomplete.md` has been removed. +### Cross‑links + +- Principles ↔ ADRs ↔ Architecture ↔ Guides ↔ QA form a closed loop: + - Principles set behavior + - ADRs lock consequential decisions + - Architecture shows where behavior lives + - Guides define exact contracts + - QA verifies behavior continuously + +## Glossary + +- Caret: The text insertion cursor in an editor. +- Validation band (band): Small neighborhood behind the caret used for safe corrections. +- Sweep: Lightweight pass that tidies recent input without heavy model calls. + ## Conventions - One canonical home per topic; avoid duplicates. If two docs drift or overlap, merge or link — don’t fork. diff --git a/docs/adr/README.md b/docs/adr/README.md index 6ac575c4..30426522 100644 --- a/docs/adr/README.md +++ b/docs/adr/README.md @@ -19,3 +19,9 @@ - 0001-template.md — ADR template - 0002-caret-safe-diff.md — Never cross caret in diffs (REQ-IME-CARETSAFE) - 0003-architecture-constraints.md — On‑device processing & UI constraints (PRD) + +Cross‑links: + +- Principles: `../system_principles.md` +- Architecture overview: `../architecture/README.md` +- QA acceptance: `../qa/acceptance/` diff --git a/docs/architecture/README.md b/docs/architecture/README.md index 62768322..4058a758 100644 --- a/docs/architecture/README.md +++ b/docs/architecture/README.md @@ -2,6 +2,13 @@ This document expands on the engineering spec and explains how the parts of the tool fit together. It is designed to provide a mental picture of the final system before implementation begins. +Cross‑links: + +- Principles: `../system_principles.md` +- ADRs: `../adr/README.md` +- Guides (reference contracts): `../guide/reference/` +- QA acceptance: `../qa/acceptance/` + ## High-Level Pipeline 1. **Keystroke Handling** – Every printable key resets the pause timer and advances a typing tick (~60–90 ms cadence) for streamed diffusion. diff --git a/docs/guide/README.md b/docs/guide/README.md index 2f024588..85450d65 100644 --- a/docs/guide/README.md +++ b/docs/guide/README.md @@ -25,3 +25,10 @@ Rules: - If it defines an API/contract/canonical behavior, it belongs in `reference/`. - If it teaches via a project, it belongs in `tutorials/`. - If it answers “why”, it belongs in `explanations/`. + +Cross‑links: + +- Principles: `../system_principles.md` +- Architecture: `../architecture/README.md` +- ADRs: `../adr/README.md` +- QA acceptance: `../qa/acceptance/` diff --git a/docs/qa/README.md b/docs/qa/README.md index 6bf8301f..c5879fa5 100644 --- a/docs/qa/README.md +++ b/docs/qa/README.md @@ -63,3 +63,9 @@ 1. Typecheck → 2) Lint → 3) Format:check → 4) Unit+Integration tests (coverage) → 5) Coverage guard → 6) E2E/A11y smoke (non-blocking; report only) Keep this file short and link to detailed specs in `docs/implementation.md` and `docs/PRD.md`. + +### Cross‑links + +- Principles → QA: Each acceptance test cites the governing principle in `docs/system_principles.md`. +- ADRs → QA: ADRs define non‑negotiables that acceptance scenarios must validate (e.g., caret safety). +- Guides → QA: Reference docs (band policy, injector, LM behavior) define the behaviors under test.