From 207e5183c5361020e0b45ac171b04dc0bad3ac47 Mon Sep 17 00:00:00 2001 From: Cristian Sotomayor Date: Wed, 7 Oct 2026 01:31:08 -0500 Subject: [PATCH 1/4] docs(plans): plan 16, docs housekeeping --- .../plans/2026-10-07-16-docs-housekeeping.md | 93 +++++++++++++++++++ 1 file changed, 93 insertions(+) create mode 100644 apps/documentation/src/content/docs/plans/2026-10-07-16-docs-housekeeping.md diff --git a/apps/documentation/src/content/docs/plans/2026-10-07-16-docs-housekeeping.md b/apps/documentation/src/content/docs/plans/2026-10-07-16-docs-housekeeping.md new file mode 100644 index 0000000..b056160 --- /dev/null +++ b/apps/documentation/src/content/docs/plans/2026-10-07-16-docs-housekeeping.md @@ -0,0 +1,93 @@ +--- +title: Plan 16 — Docs housekeeping +--- + +# Plan 16 — Docs housekeeping + +**Date:** 2026-10-07 +**Linear:** [NIW2-103](https://linear.app/niway/issue/NIW2-103) +**Reference:** `origin/main` at `ee34302` + +Bring the internal docs in line with `main`. The roadmap was last reviewed on +2026-09-02, the plans index still listed Plans 11–14 as **Planned**, and the +JSON Schema spec header still said phases 2–6 had not started. + +Every status below was checked against `gh pr list --state all` and +`git log origin/main` on 2026-10-07, not against the plan documents. + +## What the PRs say + +| Work | PR(s) | State on 2026-10-07 | +| ---------------------------------------------- | ------------------------------- | ------------------- | +| Plan 11 — response scaffolding | #54 | Merged 2026-09-03 | +| Plan 12 — package-manager toggle | #55 | Open | +| Plan 13 — terminal output, stage 2 | #56 | Open | +| ADR-0013 — mocks remember their model | #61 | Merged, superseded | +| Plan 14 — JSON Schema spec | #62 | Merged 2026-09-09 | +| Plan 14 — phases 1–2 (goldens, compiler) | #63 (into the spec branch), #64 | Merged 2026-09-09 | +| Plan 14 — phases 3–6 (stored schema, adapters) | #65 | Merged 2026-09-10 | +| Plan 15 — laqi.dev fixes and the v3 home | #68 | Merged 2026-10-05 | +| Hero demo, getting ready to record | #71 | Merged 2026-10-05 | +| Data-type fidelity (numbers, dates, > 2^53) | #73 | Merged 2026-10-06 | +| Hero demo recording published on laqi.dev | #74 | Merged 2026-10-07 | +| Releases: `laqi` 2.1.0, site 0.2.0 and 0.3.0 | #50, #48, #75 | Merged | +| Editor saved vs live state | #66 | Open | + +## Tasks + +- [ ] `product/roadmap.md`: new review date, the shipped table extended + (Plan 11, Plan 14, stored schema, v3 home, hero demo, data-type + fidelity, 2.1.0), In flight lists the three open PRs, and the + "Next" sections that have since shipped or got a PR say so. +- [ ] `plans/index.md`: status column fixed for 11–14, Plan 14 and Plan 16 + added to the table, the header paragraph no longer calls 14 and 15 + proposals. +- [ ] Plan 14's own status line, and Plan 15's. +- [ ] `design/json-schema-adapters.md`: status header says all six phases are + implemented, with the PRs. +- [ ] `adversarial/storing-models-in-mocks.md`: marked resolved, with a short + "Outcome" section pointing at what Plan 14 decided. +- [ ] Duplicate keys within one JSON file: documented on laqi.dev's + [mock files](https://laqi.dev/docs/mock-files/) page (the place a user + reads the file format), and the Plan 1 audit item marked done. +- [ ] The durable fix for the hand-maintained status column: proposed below. + Not built in this plan. + +## Durable fix — proposal: derive plan status from PR state + +The status column has drifted twice (fixed 2026-09-02, again here). Every +time, the plan documents were right about _what_ and wrong about _whether_, +because "merged" is a fact GitHub already holds and the docs copy it by hand. + +**Proposal.** Each plan declares the PRs that implement it in frontmatter, and +the status is computed from them, never written: + +```yaml +--- +title: Plan 11 — Response scaffolding on create +prs: [54] +--- +``` + +1. A script, `scripts/docs/plan-status.ts`, reads every `plans/*.md` + frontmatter, asks `gh pr view --json state,mergedAt` for each PR, and + derives one status per plan: **Merged** (every PR merged), **In review** + (at least one open), **Planned** (no PRs listed), **Abandoned** (all + closed unmerged). +2. It writes `plans/status.json` (committed), and the plans index renders its + status column from that file through a small Astro component, so the + Markdown table no longer has a status column to forget. +3. It runs in two places: by hand (`bun scripts/docs/plan-status.ts`), and in a + scheduled workflow that opens a PR when `status.json` changes. It never + runs in `validate.yml`: a PR gate that depends on the GitHub API state of + _other_ PRs would go red for reasons the PR under review did not cause. +4. `--check` mode exits non-zero when a plan's `**Status:**` prose line + contradicts the derived state, so the prose cannot drift either. + +**Why not now.** It touches the docs app's rendering, needs a workflow with a +token that can open PRs, and changes the format of every plan's frontmatter. +That is a feature, not housekeeping, and deserves its own review. + +**Open question for Cristian.** Whether the derived status should also feed the +roadmap's "Shipped" table, or the roadmap stays curated prose (it groups by +feature, not by plan, so it is not a one-to-one mapping). From 7a6c058ab6d008626efd557ab62c181d4737b815 Mon Sep 17 00:00:00 2001 From: Cristian Sotomayor Date: Wed, 7 Oct 2026 01:32:44 -0500 Subject: [PATCH 2/4] docs: fix plan statuses and the JSON Schema spec header, resolve the storing-models analysis --- .../adversarial/storing-models-in-mocks.md | 23 +++++++++++- .../docs/design/json-schema-adapters.md | 2 +- .../2026-09-07-14-json-schema-adapters.md | 2 +- .../plans/2026-10-01-15-page-truth-fixes.md | 2 +- .../src/content/docs/plans/index.md | 36 +++++++++---------- .../src/content/docs/plans/plan-01-audit.md | 7 ++-- 6 files changed, 48 insertions(+), 24 deletions(-) diff --git a/apps/documentation/src/content/docs/adversarial/storing-models-in-mocks.md b/apps/documentation/src/content/docs/adversarial/storing-models-in-mocks.md index 1f12ada..8f41cc3 100644 --- a/apps/documentation/src/content/docs/adversarial/storing-models-in-mocks.md +++ b/apps/documentation/src/content/docs/adversarial/storing-models-in-mocks.md @@ -4,7 +4,7 @@ title: Storing models in mocks — how close laqi gets to being a source of trut # Storing models in mocks — how close laqi gets to being a source of truth -**Status:** open — argues against [ADR-0013](/decisions/0013-mocks-remember-their-model/), which is written but unmerged (PR #61) +**Status:** resolved — see "Outcome" below. Argued against [ADR-0013](/decisions/0013-mocks-remember-their-model/) (PR #61), which merged and was then superseded by the [JSON Schema adapters spec](/design/json-schema-adapters/) **Date:** 2026-09-06 **Trigger:** "it would end up being a source of truth for laqi, when it should only deliver mock APIs" @@ -207,6 +207,27 @@ kept for the thirty-second case. Everything else here follows from that answer. +## Outcome + +Resolved by [Plan 14](/plans/2026-09-07-14-json-schema-adapters/), whose +answer to the open question is **no**: the paste box is a convenience, and +project references and schema imports are the durable path (its product +decisions 1, 8 and 9). + +- ADR-0013's `generatedFrom` merged in PR #61 and was then superseded. A + response no longer stores the pasted TypeScript source. +- What a response keeps is a JSON Schema (draft 2020-12) snapshot of the rules, + not the source: option B's "store the recipe, never the definition", with + JSON Schema as the compact, reviewable encoding this analysis said B lacked. +- The snapshot records imported rules and certifies nothing about the body or + the real backend; laqi never validates a body against it. +- Option C landed beside it: schemas can come from JSON Schema, OpenAPI, or the + project's own code through Standard JSON Schema. + +The contracts are in the [JSON Schema adapters spec](/design/json-schema-adapters/), +merged in PRs #62, #64 and #65 and shipped in `laqi` 2.1.0. The ledger below is +kept as it was written. + ## Ledger Not analysed yet, and deliberately not guessed at: diff --git a/apps/documentation/src/content/docs/design/json-schema-adapters.md b/apps/documentation/src/content/docs/design/json-schema-adapters.md index d505fa2..23eaa30 100644 --- a/apps/documentation/src/content/docs/design/json-schema-adapters.md +++ b/apps/documentation/src/content/docs/design/json-schema-adapters.md @@ -4,7 +4,7 @@ title: JSON Schema and adapters — design spec # JSON Schema and adapters — design spec -**Status:** phase 1 implemented; phases 2-6 not started. Derived from [Plan 14](/plans/2026-09-07-14-json-schema-adapters/) and its twelve-point review +**Status:** all six phases implemented and merged — phases 1–2 in [#64](https://github.com/csdev19/laqi/pull/64), phases 3–6 in [#65](https://github.com/csdev19/laqi/pull/65) (2026-09-10), shipped in `laqi` 2.1.0. Derived from [Plan 14](/plans/2026-09-07-14-json-schema-adapters/) and its twelve-point review **Date:** 2026-09-07, revised 2026-09-09 by what phase 1 measured **Supersedes:** the section "One source of truth: the data. Models are never persisted" in [data-generators](/design/data-generators/), and the `generatedFrom` experiment of [ADR-0013](/decisions/0013-mocks-remember-their-model/) (PR #61) and the compact-recipe experiment that followed it diff --git a/apps/documentation/src/content/docs/plans/2026-09-07-14-json-schema-adapters.md b/apps/documentation/src/content/docs/plans/2026-09-07-14-json-schema-adapters.md index 2300f3e..6b8696a 100644 --- a/apps/documentation/src/content/docs/plans/2026-09-07-14-json-schema-adapters.md +++ b/apps/documentation/src/content/docs/plans/2026-09-07-14-json-schema-adapters.md @@ -5,7 +5,7 @@ title: Plan 14 — JSON Schema and adapters # Plan 14 — JSON Schema and adapters **Date:** 2026-09-07 -**Status:** Planned — specification decisions revised after the twelve-point review on 2026-09-07. +**Status:** Merged — all six phases of the [design spec](/design/json-schema-adapters/) are on `main`: the spec in [#62](https://github.com/csdev19/laqi/pull/62), phases 1–2 in [#64](https://github.com/csdev19/laqi/pull/64) (phase 1 was first reviewed as [#63](https://github.com/csdev19/laqi/pull/63)), phases 3–6 in [#65](https://github.com/csdev19/laqi/pull/65), shipped in `laqi` 2.1.0. Specification decisions were revised after the twelve-point review on 2026-09-07. **Scope:** Replace proprietary generation metadata with JSON Schema and introduce explicit input/output adapters across the panel, local API, and MCP. diff --git a/apps/documentation/src/content/docs/plans/2026-10-01-15-page-truth-fixes.md b/apps/documentation/src/content/docs/plans/2026-10-01-15-page-truth-fixes.md index 61a5738..3b09733 100644 --- a/apps/documentation/src/content/docs/plans/2026-10-01-15-page-truth-fixes.md +++ b/apps/documentation/src/content/docs/plans/2026-10-01-15-page-truth-fixes.md @@ -5,7 +5,7 @@ title: Plan 15 — laqi.dev correctness fixes # Plan 15 — laqi.dev correctness fixes **Date:** 2026-10-01 -**Status:** All eight tasks are implemented on `fix/laqi-dev-page-claims`. +**Status:** Merged in [#68](https://github.com/csdev19/laqi/pull/68) (2026-10-05). All eight tasks were implemented on `fix/laqi-dev-page-claims`. Task 5 was resolved by removing the version badge rather than by any of the three options below; task 1's removal was then reversed, deliberately, once the recordings were about to be made. Both are recorded in their tasks. diff --git a/apps/documentation/src/content/docs/plans/index.md b/apps/documentation/src/content/docs/plans/index.md index 86afb42..1dd1bef 100644 --- a/apps/documentation/src/content/docs/plans/index.md +++ b/apps/documentation/src/content/docs/plans/index.md @@ -4,13 +4,11 @@ title: Implementation plans # Implementation plans -Latest proposal: [Plan 15 — laqi.dev correctness fixes](/plans/2026-10-01-15-page-truth-fixes/). -Fixes what the [2026-10-01 page audit](/product/page-audit-2026-10-01/) found false on -the live site, before any rewrite of its argument. **Planned.** - -[Plan 14 — JSON Schema and adapters](/plans/2026-09-07-14-json-schema-adapters/) -replaces experimental generation metadata with JSON Schema and plans shared input -and export adapters, local library integrations, and transport parity. **Planned.** +Latest plan: [Plan 16 — Docs housekeeping](/plans/2026-10-07-16-docs-housekeeping/). +It brings these docs back in line with `main`, and proposes deriving the status +column below from PR state instead of maintaining it by hand. Until that lands, +the column is hand-maintained: last checked against `gh pr list` on +**2026-10-07**. v2.0.0 was built in six plans (plan 2 was split in two so each could close with its own PR). Each one produces working software that can be tested on its own, @@ -32,17 +30,19 @@ table. Plans from 6 onward are post-v2.0.0 work. Further plans, past v2.0.0 itself, build on top of it: -| # | Plan | Delivers | Status | -| --- | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- | -| 6 | [Data generators](/plans/2026-08-27-06-data-generators/) | Types in 27 languages derived from live response data, and seeded mock data generated from a pasted TypeScript model — both from the panel, the control-plane API and MCP tools. Audited: [audit and backlog](/plans/plan-06-audit/) — 11 findings, the five High ones fixed. | **Merged** — [PR #16](https://github.com/csdev19/laqi/pull/16) | -| 7 | [Release and publishing](/plans/2026-08-28-07-release-and-publication/) | release-please with a single version line, a tag-triggered npm publish on the `beta` dist-tag, and a PR gate for format, lint, types and tests. Decided in [ADR-0010](/decisions/0010-release-and-npm/). The `beta` dist-tag was dropped before merge — v2 shipped as plain `2.0.0`. | **Merged** — PRs [#19](https://github.com/csdev19/laqi/pull/19) / [#31](https://github.com/csdev19/laqi/pull/31) | -| 8 | [Terminal output, stage 1](/plans/2026-08-28-08-terminal-output/) | One rendering layer for start, failures and goodbye, plus the session counters the summary reads. Designed in [terminal-output](/design/terminal-output/). Stage 2 is [Plan 13](/plans/2026-09-02-13-terminal-request-stream/). | **Merged** — [PR #21](https://github.com/csdev19/laqi/pull/21) | -| 9 | [English migration](/plans/2026-08-29-09-english-migration/) | Code comments, the docs tree and every user-facing surface moved to English, per [ADR-0009](/decisions/0009-no-i18n/). | **Merged** — [PR #32](https://github.com/csdev19/laqi/pull/32) | -| 10 | [laqi.dev, first slice](/plans/2026-08-29-10-laqi-dev-site/) | `apps/site`: the landing page, three docs pages, shared design tokens in `packages/tokens`, and deploy to Cloudflare Pages on merge to `main`. | **Merged** — [PR #33](https://github.com/csdev19/laqi/pull/33) | -| 11 | [Response scaffolding on create](/plans/2026-09-02-11-response-scaffolding/) | A status combobox that names every code it offers, and a one-click scaffold of the response family a method and path shape imply — panel and MCP, from one definition in `@laqi/schema`. | **Planned** | -| 12 | [Package-manager toggle](/plans/2026-09-02-12-package-manager-toggle/) | npm / pnpm / yarn / bun on laqi.dev, swapped in place and remembered, from one verified command matrix. Task 1 is running every command before any copy is written. | **Planned** | -| 13 | [Terminal output, stage 2](/plans/2026-09-02-13-terminal-request-stream/) | The request stream in the terminal and the four keys stage 1 could not advertise (`o` `s` `c` `q`), plus `via public` on streamed requests. The QR is deferred. | **Planned** | -| 15 | [laqi.dev correctness fixes](/plans/2026-10-01-15-page-truth-fixes/) | The eight correctness defects the [2026-10-01 page audit](/product/page-audit-2026-10-01/) found live on laqi.dev — empty demo placeholders, a wrong MCP tool count, two hero badges contradicted by the page itself, YAML advertised where only JSON is accepted, and a version badge stale by construction. Positioning and new sections are excluded by design. | **Merged** — [PR #68](https://github.com/csdev19/laqi/pull/68) | +| # | Plan | Delivers | Status | +| --- | ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 6 | [Data generators](/plans/2026-08-27-06-data-generators/) | Types in 27 languages derived from live response data, and seeded mock data generated from a pasted TypeScript model — both from the panel, the control-plane API and MCP tools. Audited: [audit and backlog](/plans/plan-06-audit/) — 11 findings, the five High ones fixed. | **Merged** — [PR #16](https://github.com/csdev19/laqi/pull/16) | +| 7 | [Release and publishing](/plans/2026-08-28-07-release-and-publication/) | release-please with a single version line, a tag-triggered npm publish on the `beta` dist-tag, and a PR gate for format, lint, types and tests. Decided in [ADR-0010](/decisions/0010-release-and-npm/). The `beta` dist-tag was dropped before merge — v2 shipped as plain `2.0.0`. | **Merged** — PRs [#19](https://github.com/csdev19/laqi/pull/19) / [#31](https://github.com/csdev19/laqi/pull/31) | +| 8 | [Terminal output, stage 1](/plans/2026-08-28-08-terminal-output/) | One rendering layer for start, failures and goodbye, plus the session counters the summary reads. Designed in [terminal-output](/design/terminal-output/). Stage 2 is [Plan 13](/plans/2026-09-02-13-terminal-request-stream/). | **Merged** — [PR #21](https://github.com/csdev19/laqi/pull/21) | +| 9 | [English migration](/plans/2026-08-29-09-english-migration/) | Code comments, the docs tree and every user-facing surface moved to English, per [ADR-0009](/decisions/0009-no-i18n/). | **Merged** — [PR #32](https://github.com/csdev19/laqi/pull/32) | +| 10 | [laqi.dev, first slice](/plans/2026-08-29-10-laqi-dev-site/) | `apps/site`: the landing page, three docs pages, shared design tokens in `packages/tokens`, and deploy to Cloudflare Pages on merge to `main`. | **Merged** — [PR #33](https://github.com/csdev19/laqi/pull/33) | +| 11 | [Response scaffolding on create](/plans/2026-09-02-11-response-scaffolding/) | A status combobox that names every code it offers, and a one-click scaffold of the response family a method and path shape imply — panel and MCP, from one definition in `@laqi/schema`. | **Merged** — [PR #54](https://github.com/csdev19/laqi/pull/54) | +| 12 | [Package-manager toggle](/plans/2026-09-02-12-package-manager-toggle/) | npm / pnpm / yarn / bun on laqi.dev, swapped in place and remembered, from one verified command matrix. Task 1 is running every command before any copy is written. | **In review** — [PR #55](https://github.com/csdev19/laqi/pull/55), open | +| 13 | [Terminal output, stage 2](/plans/2026-09-02-13-terminal-request-stream/) | The request stream in the terminal and the four keys stage 1 could not advertise (`o` `s` `c` `q`), plus `via public` on streamed requests. The QR is deferred. | **In review** — [PR #56](https://github.com/csdev19/laqi/pull/56), open | +| 14 | [JSON Schema and adapters](/plans/2026-09-07-14-json-schema-adapters/) | JSON Schema (draft 2020-12) replaces the experimental generation metadata. A response stores the schema its body came from, regenerates from it, and refuses a blind overwrite. Schemas come from pasted TypeScript, JSON Schema, OpenAPI or the project's own code through Standard JSON Schema. Contracts in [json-schema-adapters](/design/json-schema-adapters/). | **Merged** — spec [#62](https://github.com/csdev19/laqi/pull/62), phases 1–2 [#64](https://github.com/csdev19/laqi/pull/64), phases 3–6 [#65](https://github.com/csdev19/laqi/pull/65) | +| 15 | [laqi.dev correctness fixes](/plans/2026-10-01-15-page-truth-fixes/) | The eight correctness defects the [2026-10-01 page audit](/product/page-audit-2026-10-01/) found live on laqi.dev — empty demo placeholders, a wrong MCP tool count, two hero badges contradicted by the page itself, YAML advertised where only JSON is accepted, and a version badge stale by construction. Positioning and new sections are excluded by design. | **Merged** — [PR #68](https://github.com/csdev19/laqi/pull/68) | +| 16 | [Docs housekeeping](/plans/2026-10-07-16-docs-housekeeping/) | The roadmap, this status column and the spec headers brought back in line with `main`, plus a proposal to derive this column from PR state. | **In review** | ## Why this order diff --git a/apps/documentation/src/content/docs/plans/plan-01-audit.md b/apps/documentation/src/content/docs/plans/plan-01-audit.md index 2444602..ef4f201 100644 --- a/apps/documentation/src/content/docs/plans/plan-01-audit.md +++ b/apps/documentation/src/content/docs/plans/plan-01-audit.md @@ -103,8 +103,11 @@ hot-swapping the app without releasing the socket, `close()`) against distinguishes by `runtime.source`. - Noted the limitation that two duplicate keys **within the same file** get deduplicated by `JSON.parse` before the loader ever sees them (the last one - wins) — inherent to JSON; ADR-0008's detection is across files. Still needs - documenting in Plan 5. + wins) — inherent to JSON; ADR-0008's detection is across files. Documented + on 2026-10-07 ([Plan 16](/plans/2026-10-07-16-docs-housekeeping/)) in the + public "Mock files" page (`apps/site/src/content/docs/docs/mock-files.md`, + section "Duplicate keys"), after re-checking on `main` that it still loads + silently with no error and serves the last one. ## Verified and correct (no changes) From 531a63d5eabc9f06a28bcf951d2c8b0c4124ba08 Mon Sep 17 00:00:00 2001 From: Cristian Sotomayor Date: Wed, 7 Oct 2026 01:32:44 -0500 Subject: [PATCH 3/4] docs(site): say what laqi does with a duplicate key in one file --- apps/site/src/content/docs/docs/mock-files.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/apps/site/src/content/docs/docs/mock-files.md b/apps/site/src/content/docs/docs/mock-files.md index d787e6c..1ea7b6e 100644 --- a/apps/site/src/content/docs/docs/mock-files.md +++ b/apps/site/src/content/docs/docs/mock-files.md @@ -33,6 +33,18 @@ exist. Each file is a JSON object whose keys are `"METHOD /path"`: - `:param` segments in a path are dynamic — `/users/:id` matches `/users/42`. +## Duplicate keys + +**Within one file, a repeated key is dropped without a warning.** If a file +declares `"GET /users"` twice, laqi serves the **last** one and never sees the +first: the JSON parser keeps one value per key before laqi reads the file. The +same applies to any repeated key inside an endpoint, such as two responses +with the same name. + +**Across files, the same endpoint is an error.** With a `laqi/` folder, if +two files both declare `"GET /users"`, laqi reports the collision with both +file names and serves neither until one is removed or renamed. + ## Numbers, dates and other values A body is served as the JSON value the file holds. Strings, `null`, booleans, From ccc82f35aa0f557163b5d423a694b4b91a983975 Mon Sep 17 00:00:00 2001 From: Cristian Sotomayor Date: Wed, 7 Oct 2026 01:33:34 -0500 Subject: [PATCH 4/4] docs(roadmap): review against main on 2026-10-07 --- .../plans/2026-10-07-16-docs-housekeeping.md | 14 ++--- .../src/content/docs/product/roadmap.md | 59 ++++++++++++++----- 2 files changed, 52 insertions(+), 21 deletions(-) diff --git a/apps/documentation/src/content/docs/plans/2026-10-07-16-docs-housekeeping.md b/apps/documentation/src/content/docs/plans/2026-10-07-16-docs-housekeeping.md index b056160..3f8fe59 100644 --- a/apps/documentation/src/content/docs/plans/2026-10-07-16-docs-housekeeping.md +++ b/apps/documentation/src/content/docs/plans/2026-10-07-16-docs-housekeeping.md @@ -35,22 +35,22 @@ Every status below was checked against `gh pr list --state all` and ## Tasks -- [ ] `product/roadmap.md`: new review date, the shipped table extended +- [x] `product/roadmap.md`: new review date, the shipped table extended (Plan 11, Plan 14, stored schema, v3 home, hero demo, data-type fidelity, 2.1.0), In flight lists the three open PRs, and the "Next" sections that have since shipped or got a PR say so. -- [ ] `plans/index.md`: status column fixed for 11–14, Plan 14 and Plan 16 +- [x] `plans/index.md`: status column fixed for 11–14, Plan 14 and Plan 16 added to the table, the header paragraph no longer calls 14 and 15 proposals. -- [ ] Plan 14's own status line, and Plan 15's. -- [ ] `design/json-schema-adapters.md`: status header says all six phases are +- [x] Plan 14's own status line, and Plan 15's. +- [x] `design/json-schema-adapters.md`: status header says all six phases are implemented, with the PRs. -- [ ] `adversarial/storing-models-in-mocks.md`: marked resolved, with a short +- [x] `adversarial/storing-models-in-mocks.md`: marked resolved, with a short "Outcome" section pointing at what Plan 14 decided. -- [ ] Duplicate keys within one JSON file: documented on laqi.dev's +- [x] Duplicate keys within one JSON file: documented on laqi.dev's [mock files](https://laqi.dev/docs/mock-files/) page (the place a user reads the file format), and the Plan 1 audit item marked done. -- [ ] The durable fix for the hand-maintained status column: proposed below. +- [x] The durable fix for the hand-maintained status column: proposed below. Not built in this plan. ## Durable fix — proposal: derive plan status from PR state diff --git a/apps/documentation/src/content/docs/product/roadmap.md b/apps/documentation/src/content/docs/product/roadmap.md index bea093a..bb528b9 100644 --- a/apps/documentation/src/content/docs/product/roadmap.md +++ b/apps/documentation/src/content/docs/product/roadmap.md @@ -5,10 +5,11 @@ description: What has shipped, what is in flight, and what comes next — the si # Roadmap -**Last reviewed: 2026-09-02.** Statuses here are verified against merged -PRs, not against plan documents. +**Last reviewed: 2026-10-07.** Statuses here are verified against merged +PRs (`gh pr list --state all`), not against plan documents. Current release: +`laqi` **2.1.0** (2026-10-06), laqi.dev site **0.3.0**. -## Shipped — in v2.0.0's scope, merged to `main` +## Shipped — merged to `main` | What | Where it landed | | ------------------------------------------------------------------------------------------------------------------- | ------------------- | @@ -26,12 +27,34 @@ PRs, not against plan documents. | laqi.dev: landing page, three docs pages, shared tokens, deploy on merge | Plan 10, PR #33 | | Effect-first inside `@laqi/generate`: services, layers, a module-local runtime | ADR-0012, PR #51 | +### Shipped since 2.0.1 — in 2.1.0 and site 0.2.0 / 0.3.0 + +| What | Where it landed | +| --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | +| Response scaffolding: a status combobox that names every code, a one-click scaffold of the usual sibling responses, and the `scaffold_responses` MCP tool | Plan 11, PR #54 | +| A small TypeScript editor for pasted models, with example models | PR #58 | +| Writes confined to the mocks directory | PR #59 | +| Stored schema: a response remembers the JSON Schema its body came from, regenerates from it, and refuses a blind overwrite | Plan 14, PRs #62/#64/#65 | +| Schema inputs: pasted TypeScript, JSON Schema, OpenAPI through the real compiler, the project's own code through Standard JSON Schema | Plan 14, PR #65 | +| laqi.dev correctness fixes, and the home page rebuilt as the v3 design | Plan 15, PR #68 | +| Hero demo: the example made ready to record, a stale override no longer blocks every flip, and the recording published on laqi.dev | PRs #71/#74, site 0.3.0 | +| Data-type fidelity: numbers, dates and odd JSON values reach the client as written; integers > 2^53 are reported and files holding them refuse rewrites | PR #73 | + ## In flight -Nothing. `2.0.1` is published, laqi.dev is live, and the Effect-first change -set merged on 2026-09-02. +Three PRs are open, none merged: + +- **#55 — package-manager toggle on laqi.dev** ([Plan 12](/plans/2026-09-02-12-package-manager-toggle/)). +- **#56 — terminal request stream and the `o`/`s`/`c`/`q` keys** ([Plan 13](/plans/2026-09-02-13-terminal-request-stream/)). +- **#66 — the editor's saved vs live response state.** Missed 2.1.0; targeted + at 2.1.1. -## Next — committed direction, not yet planned +Known follow-ups from the 2.1.0 release review (Linear NIW2-8): `laqi mcp` +reports a hardcoded server version, OpenAPI `int64`/`int32` bounds can generate +out-of-range integers, integers > 2^53 are reported but not served losslessly, +and the install is ~92 MB. + +## Next — committed direction ### Package-manager toggle on laqi.dev @@ -46,7 +69,8 @@ applied to every install snippet across the site. The site is static Astro, so this is a small client-side island. Before shipping: actually verify the global-install and runner paths on each manager (yarn classic vs berry differ on `global`) — that verification is Task 1 of -**[Plan 12](/plans/2026-09-02-12-package-manager-toggle/)**. +**[Plan 12](/plans/2026-09-02-12-package-manager-toggle/)**. Implemented in +PR #55, open and unmerged as of 2026-10-07. ### Terminal output, stages 2 and 3 @@ -62,10 +86,8 @@ Planned in **[Plan 13](/plans/2026-09-02-13-terminal-request-stream/)**, which covers the stream, the keys and `via public`. The QR is held back there: it needs either a new published dependency or a Reed-Solomon encoder bundled into `@laqi/tui`, and `apps/cli/src/package.test.ts` asserts the dependency list -exactly — so that is an ADR, not a task. - -This section is new. The work existed in the design doc and in the plan index, -and never appeared here, which is how it went unnoticed. +exactly — so that is an ADR, not a task. The stream, the keys and +`via public` are implemented in PR #56, open and unmerged as of 2026-10-07. ### WebSocket mocking @@ -112,6 +134,15 @@ visibly wrong. The full table lives in the audit. ## Housekeeping - ~~The [plans index](/plans/) status column is stale.~~ Corrected on - 2026-09-02: plans 6–8 now read Merged, and plans 9–13 are listed. The column - is still hand-maintained, so it will drift again — deriving it from PR state - is the durable fix and has not been done. + 2026-09-02, and again on 2026-10-07 by + [Plan 16](/plans/2026-10-07-16-docs-housekeeping/): 11, 14 and 15 read + Merged, 12 and 13 read In review. The column is still hand-maintained, so it + will drift again. Plan 16 proposes the durable fix (plan frontmatter lists + its PRs, a script derives the status); it is not built yet. +- ~~The JSON Schema spec header said phases 2–6 had not started.~~ Corrected + on 2026-10-07; all six phases are merged. +- ~~[Storing models in mocks](/adversarial/storing-models-in-mocks/) was still + open.~~ Marked resolved on 2026-10-07, with an Outcome section. +- ~~Duplicate keys within one JSON file are deduplicated silently and nobody + says so (Plan 1 audit, Minor).~~ Documented on laqi.dev's Mock files page on + 2026-10-07.