From d1102e12c506328d24d4e70eb2b7403a31cbae2f Mon Sep 17 00:00:00 2001 From: Eric Rakestraw Date: Sat, 7 Nov 2026 16:01:14 +0000 Subject: [PATCH] Correct reporting and release navigation --- README.md | 9 +++------ docs/adr/0006-invocation-reporting.md | 3 +++ docs/development.md | 3 +++ docs/roadmap/audit/catalog.md | 12 +++++++++++- docs/roadmap/implementation.md | 7 ++++++- integrations/ckprompt/docs/releases/errata.md | 4 ++++ 6 files changed, 30 insertions(+), 8 deletions(-) create mode 100644 integrations/ckprompt/docs/releases/errata.md diff --git a/README.md b/README.md index 37880b7..98c5ccb 100644 --- a/README.md +++ b/README.md @@ -22,12 +22,9 @@ defines the shared visibility policy. | `go.maximumdirect.net/ckconfig` | `ckconfig` | ConfigKit-backed `config` scopes, including configuration source evidence. | | `go.maximumdirect.net/ckprompt` | `ckprompt` | PromptKit engine configuration/comparison, five catalogs, named inspection, requirements discovery, concrete request validation, and native smoke tests. | -Importing an integration does not install commands. Core v0.4.0 is published; -the published ckconfig and ckprompt v0.2.0 modules use core v0.3.0. The published -ckconfig v0.3.0 uses ConfigKit v1.1.0 and does not compose with -ckprompt v0.2.0; the published v0.2.0 pair remains matched. Published ckconfig -v0.4.0 uses core v0.4.0; the current ckprompt candidate selects both. See the -[consumer guide](docs/consumers/guide.md#module-selection) for dependency details. +Importing an integration does not install commands. Core and the integrations +are versioned separately; see the [consumer guide](docs/consumers/guide.md#module-selection) +for published versions, compatibility, and installation choices. ## Examples diff --git a/docs/adr/0006-invocation-reporting.md b/docs/adr/0006-invocation-reporting.md index 9c462aa..4697547 100644 --- a/docs/adr/0006-invocation-reporting.md +++ b/docs/adr/0006-invocation-reporting.md @@ -5,6 +5,9 @@ Accepted. The structured-report formatting extension is implemented; its adoption record is preserved in [Git history](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/2f43f78f76439f5d11ef313cd379bec036543504/docs/roadmap/promptkit-v0.20.0.md#shared-core-report-output-prerequisite). +The future-tense implementation and roadmap references in the decision and +consequences below are historical. Current contracts are owned by the +[reporting GoDoc](../../report.go) and [CLI reference](../cli.md#reporting). ## Date diff --git a/docs/development.md b/docs/development.md index c27179e..1e486de 100644 --- a/docs/development.md +++ b/docs/development.md @@ -81,6 +81,9 @@ These records are not assignments to restart completed work. The [future work record](roadmap/future.md) preserves unfinished work and unselected proposals separately from current contracts. +The [ckprompt release errata](../integrations/ckprompt/docs/releases/errata.md) +corrects navigation in a historical release note. + ## Documentation validation For current prose work, inspect relevant diffs, check local links and fragment diff --git a/docs/roadmap/audit/catalog.md b/docs/roadmap/audit/catalog.md index 325f351..a9933c6 100644 --- a/docs/roadmap/audit/catalog.md +++ b/docs/roadmap/audit/catalog.md @@ -1,6 +1,6 @@ # Consolidated audit catalog -Status: **3 distinct open findings: 3 P3**, consolidated from 30 +Status: **no open findings**, consolidated from 30 numbered entries in seven audit documents. Reviewed audit state: `db732e3a1de55c844f77870e1c6db683c2685d5d`. @@ -539,6 +539,9 @@ assertions without new exported test hooks. ## F25 — P3: The reporting ADR mixes implemented status with stale planning language +**Complete.** ADR status identifies its future-tense lifecycle language as +historical and points to current GoDoc and CLI contracts. + ADR 0006 marks shared reporting implemented but still directs implementation status and format choices to a retired roadmap and describes the extension as planned. Readers can mistake completed work for a pending prerequisite. @@ -551,6 +554,9 @@ does not need a replacement ADR. ## F26 — P3: The README duplicates volatile module compatibility guidance +**Complete.** README keeps module orientation and links to the consumer guide +as the owner of exact compatibility and installation guidance. + The root README repeats exact version combinations and candidate dependency details already maintained by the consumer guide. The facts currently agree, but two owners create policy and maintenance drift risk. @@ -563,6 +569,10 @@ consolidation, not a dependency change. ## F27 — P3: A historical release note points to a nonexistent section +**Complete.** A discoverable forward-only erratum links the corrected section, +verified against the locally tagged consumer guide. The historical note and tag +were not changed. + The ckprompt v0.2.0 release note uses the wrong consumer-guide fragment at its immutable tag. The file exists, but the requested section does not. diff --git a/docs/roadmap/implementation.md b/docs/roadmap/implementation.md index b9840e4..049b3fa 100644 --- a/docs/roadmap/implementation.md +++ b/docs/roadmap/implementation.md @@ -1,6 +1,6 @@ # Audit remediation implementation plan -Status: in progress; Stages 1–21 complete. +Status: in progress; Stages 1–22 complete. Baseline: `d492c7747175c01a53261206c2b4356e53453621`. Before this sprint, intervening changes recorded decisions and retired the completed older @@ -685,6 +685,11 @@ validation or a new public pointer utility. ## Stage 22 — Correct current documentation and historical navigation +**Complete.** ADR status identifies historical lifecycle language, README links +to the consumer guide's compatibility owner, and the forward-only ckprompt +v0.2.0 erratum links the corrected pinned section. The heading was verified in +the tagged Git object and Markdown whitespace checks passed. + Findings: F25, F26 and F27. 1. In ADR 0006's Status section, explicitly mark remaining pre-implementation diff --git a/integrations/ckprompt/docs/releases/errata.md b/integrations/ckprompt/docs/releases/errata.md new file mode 100644 index 0000000..32d0418 --- /dev/null +++ b/integrations/ckprompt/docs/releases/errata.md @@ -0,0 +1,4 @@ +# ckprompt release errata + +The v0.2.0 release note links to the wrong consumer-guide section. The correct +pinned section is [PromptKit configuration, definitions, and requirements](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckprompt/v0.2.0/docs/consumers/guide.md#promptkit-configuration-definitions-and-requirements).