Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<!--══════════════════════════════════════════════════════════
╔══════════════════════════════════════════════════════════════╗
║ ░ D O C S I N D E X ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ║
║ ║
║ ║
║ ║
║ ║
║ ╌╌ P L A C E H O L D E R ╌╌ ║
║ ║
║ ║
║ ║
║ ║
╚══════════════════════════════════════════════════════════════╝
• WHAT ▸ Overview and folder purposes for documentation
• WHY ▸ Keep navigation clear; avoid duplication and drift
• HOW ▸ Short descriptions + links to canonical locations
-->

## Folder purposes

- Root (this folder)
- Top‑level product/plan docs and indices: `PRD.md`, `implementation.md`, `system_principles.md`, `project_structure.md`, `backlog.md`. Start here for the current plan and principles.

- `architecture/`
- System design and C4 views. Use `README.md` for the overview; `C1-context.md`, `C2-containers.md`, `C3-components.md` for deeper levels. ADRs live separately under `adr/`.

- `adr/`
- Architectural Decision Records. Each ADR is a permanent, numbered record that links PRD requirements to code paths and consequences.

- `guide/`
- Developer‑facing guidance using Diátaxis:
- `how-to/` — step‑by‑step tasks (web demo server, mac app details, etc.)
- `tutorials/` — learn by doing (try MindTyper in 5 min)
- `reference/` — APIs and contracts (band policy, injector, LM behavior, worker, rust merge, config flags)
- `explanations/` — deeper rationale (e.g., why caret‑safe diffs)

- `qa/`
- Quality gates and acceptance (BDD) scenarios; matrix mapping in `qa/README.md`.

- `a11y/`
- Accessibility standards and checklists.

- `brand/`
- Brand assets, specs, and guides (visual identity, tone, motion). Not product behavior.

- `questionnaire/`
- Product questionnaire sections and live `questions.md` (clarifications). Treat as the primary Q&A surface; deprecated `questions-incomplete.md` has been removed.

## Conventions

- One canonical home per topic; avoid duplicates. If two docs drift or overlap, merge or link — don’t fork.
- Cross‑link related content (PRD ↔ ADR ↔ architecture ↔ guides ↔ QA) for traceability.
- Keep Swiss‑grid headers; prefer concise files with hyperlinks over long monoliths.
14 changes: 14 additions & 0 deletions docs/a11y/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!--══════════════════════════════════════════════════════════
╔══════════════════════════════════════════════════════════════╗
║ ░ A 1 1 Y I N D E X ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ║
║ ║
║ Accessibility docs and checklists (WCAG 2.2 AA). ║
║ ║
╚══════════════════════════════════════════════════════════════╝
• WHAT ▸ Centralize accessibility standards and audits
• WHY ▸ Enforce inclusive defaults across product
• HOW ▸ Keep concise checklists + links to specs
-->

- Checklist: `wcag-checklist.md`
- Principles: respect reduced motion; never rely on color/motion alone; SR announces via `ui/liveRegion.ts`.
27 changes: 27 additions & 0 deletions docs/guide/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!--══════════════════════════════════════════════════════════
╔══════════════════════════════════════════════════════════════╗
║ ░ G U I D E S I N D E X ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ║
║ ║
║ How‑to, tutorials, references, and explanations for devs. ║
║ ║
║ ║
║ ║
╚══════════════════════════════════════════════════════════════╝
• WHAT ▸ Diátaxis structure for developer docs
• WHY ▸ Predictable navigation + single sources of truth
• HOW ▸ Each subfolder has a clear purpose (below)
-->

## Structure

- `how-to/` — Task‑oriented guides (e.g., web demo server, mac app details, fine‑tune Qwen).
- `tutorials/` — Learn‑by‑doing walkthroughs (e.g., try MindTyper in 5 minutes).
- `reference/` — Stable contracts and APIs (band policy, injector, LM behavior, worker, rust merge, config flags).
- `explanations/` — Rationale and deep dives (e.g., why caret‑safe diffs).

Rules:

- If a document specifies “how”, it belongs in `how-to/`.
- 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/`.
25 changes: 0 additions & 25 deletions docs/questionnaire/questions-incomplete.md

This file was deleted.

File renamed without changes.
Loading