From 995c0ba8eb5fd835cba8e6d290c2430945dfe3c8 Mon Sep 17 00:00:00 2001 From: "claude@clouddev1" Date: Tue, 9 Jun 2026 22:30:44 +0000 Subject: [PATCH] docs: reconcile website doc inventory with merged main scope The merge from main added user-facing surface the pre-merge inventory had listed as planned. Mark them documented-as-shipped: show tables / relationships / indexes + show relationship/index (V5/V5a), help [] + help types (H3), compound-primary-key foreign-key references (T3, ADR-0043), and friendlier parse-error messaging (H1a). Refresh the test count to 2193 and note requirements.md now uses a [/] partial marker (trust the code, not the marker). --- docs/plans/20260604-adr-0044-website.md | 28 ++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/docs/plans/20260604-adr-0044-website.md b/docs/plans/20260604-adr-0044-website.md index 86bcea6..e146144 100644 --- a/docs/plans/20260604-adr-0044-website.md +++ b/docs/plans/20260604-adr-0044-website.md @@ -35,11 +35,15 @@ Root `.gitignore` gains `website/node_modules`, `website/dist`, ## Documentation inventory (grounded — drives Phase D scope) -Built from `docs/handoff/55–57`, `docs/adr/*`, the command REGISTRY +Built from `docs/handoff/55–59`, `docs/adr/*`, the command REGISTRY (`src/dsl/grammar/mod.rs:603`, which also auto-assembles in-app `help`), the `Command` enum (`src/dsl/command.rs:149`), and `src/friendly/strings/en-US.yaml` — **not** the coarse `requirements.md` -checkboxes. Test state at survey time: **2151 passing, 0 failing, 1 ignored.** +checkboxes (handoff-59 found those ~46% mis-marked; they now use a `[/]` +"partial" legend — trust the code, not the marker). Refreshed **2026-06-09 +after merging `main`**, which added the show-list/detail, `help `, +and compound-PK FK surface (see the dedicated bullet below). Test state: +**2193 passing, 0 failing, 1 ignored.** **SHIPPED — document as-is (the doc core):** - Input modes: simple, advanced (SQL), `:` one-shot escape, `mode` command, @@ -68,16 +72,26 @@ checkboxes. Test state at survey time: **2151 passing, 0 failing, 1 ignored.** (ADR-0019/0027), DSL→SQL teaching echo (ADR-0038), EXPLAIN plan tree (ADR-0028), box-drawing tables (ADR-0016), tab completion + syntax highlighting + in-line editing (ADR-0022). +- **Added by the `main` merge (2026-06-09):** schema-inspection commands + `show tables` / `show relationships` / `show indexes` and the singular + `show relationship ` / `show index ` detail views (V5/V5a); + `help []` per-command detail + `help types` + general reference + (H3); **compound-primary-key foreign-key references** — DSL + `from

.(a, b) to .(x, y)` and SQL `FOREIGN KEY (a, b) REFERENCES + P(x, y)` (single-column form unchanged) (ADR-0043, T3); friendlier + parse-error near-miss messaging (H1a, ADR-0042). These need coverage: a + schema-inspection page (the `show` family) and compound-FK examples on the + Relationships page. **DOCUMENT WITH CAVEAT:** `add unique index` is advanced-only; simple-mode table rename is intentionally absent (rename is `ALTER TABLE … RENAME TO`); -FK references target single-column PKs only (compound-PK FK refs pending); -`help ` detail and richer `hint` (H2/H3) still partial. +`hint` (H2) is still partial; a compound-FK *violation* message names only +the first column pair (enforcement is correct — a messaging-only residual). **OMIT or MARK "planned":** multi-line input (I1), readline shortcuts (I1b), -in-flight cancellation / query timeout (I5/B3), `seed` (SD1), `m:n` (C4), -one-step modify relationship (C3a), `show tables`/`relationships`/`indexes` -(V5), ER-diagram view/export (V1/V3), session-log + Markdown export (V4). +in-flight cancellation / query timeout (I5/B3), `seed` (SD1), `m:n` +convenience (C4), one-step modify relationship (C3a), relationship line-art +(V1), ER-diagram export (V3), session-log + Markdown export (V4). **Mine verbatim for docs:** `en-US.yaml` `help.app.*`, `help.ddl.*`, `help.data.*`, `help.types_reference`, `parse.usage.*` (one-line syntax