diff --git a/docs/roadmap/implementation.md b/docs/roadmap/implementation.md index ba37424..6e12d36 100644 --- a/docs/roadmap/implementation.md +++ b/docs/roadmap/implementation.md @@ -1,10 +1,29 @@ # Initial CommandKit implementation plan -Status: implementation complete; Stages 1-14 complete. +Status: completed execution record; Stages 1-14 complete. Date: 2026-10-07. -## Purpose and instructions for the implementation agent +## Record scope and current owners + +The staged instructions and API illustrations below are retained as the record +of the completed initial implementation. They describe the assignments used to +produce the [selected feature target](initial.md), not work to restart. The +[CLI reference](../cli.md) owns current operator behavior, Go declarations and +GoDoc own current API contracts, the [consumer guide](../consumers/guide.md) owns +usage guidance, and the [internal overview](../internal/overview.md) owns mechanics. + +### Subsequent code remediation + +After original stage completion at `85f44cd`, ten code-remediation units were +committed from `d8db15f` through `cb0b8dd`. They corrected scope-specific required +selectors, inline YAML framing, cancellation boundaries, help failure delivery, +validation delivery errors, outcome defaults, nil diagnostic handling, scope +choices, selector-name collisions, and metadata-only help discovery. These +corrections are reflected in current code and its regression checks. Original +stage completion notes remain historical evidence, not a new validation run. + +## Historical instructions for the implementation agent Implement the selected end state in [the feature roadmap](initial.md). Read this whole plan before starting. Complete Stage 1, then each subsequent stage in numeric @@ -778,8 +797,10 @@ func RegisterPromptKit[C any](app *App, suite PromptKitSuite[C]) error bookkeeping. Configuration scope installation remains independent. 3. Accept ID as one required operand. Prompt alone has singleton `--version` (default empty). Both accept standard Config/Overlay selection, context-selector - bindings, and `--format text|yaml` (text default), plus help. No `--scope` is - installed for definition commands. Selector target is `promptkit`; empty Scopes + bindings, and `--format text|yaml` (text default), plus help. No built-in configuration-scope selector is + installed for definition commands; a custom context selector can use the name + `scope` when it does not collide with an installed flag. Selector target is + `promptkit`; empty Scopes or a list containing promptkit applies, independent of a config scope registry. Other explicit targets are miswired metadata at registration. 4. Reuse Stage 7's input/context creation and input-check rules. Missing ID is diff --git a/docs/roadmap/initial.md b/docs/roadmap/initial.md index 04830b7..21c707a 100644 --- a/docs/roadmap/initial.md +++ b/docs/roadmap/initial.md @@ -1,6 +1,6 @@ # Initial CommandKit feature roadmap -Status: selected initial implementation target; implemented. +Status: selected initial target implemented; completed design baseline. Date: 2026-10-07. @@ -9,8 +9,10 @@ Date: 2026-10-07. This document defines the selected initial target for the library: packages, features, integration contracts, dependencies, and completion evidence. It was prepared using [the agreed checklist](initial-plan.md). Implementation steps and -stage evidence belong in [the implementation plan](implementation.md). The -included target is implemented; the table below records feature status. +stage evidence belong in [the completed implementation plan](implementation.md). +Detailed specifications below preserve the selected design baseline; they are +planning history, not a parallel current API or operator reference. The included +target is implemented; the table below records feature status. | Included feature IDs | Status | Evidence | | --- | --- | --- | @@ -25,8 +27,10 @@ The [architecture policy](../policy/architecture.md) and nine accepted ADRs cont this roadmap. The delivery scope, typed API model, selector/report behavior, and full profile inspection described here were selected during roadmap review. These implementation choices operate within the accepted architecture. Exact -exported contracts will belong in Go declarations and GoDoc; implemented operator -contracts will belong in `docs/cli.md`. +exported contracts belong in Go declarations and GoDoc, navigated through the +[consumer guide](../consumers/guide.md); implemented operator contracts belong in +the [CLI reference](../cli.md). The [internal overview](../internal/overview.md) +owns current package inventory and mechanics. ### Requirements and traceability diff --git a/docs/roadmap/remediation.md b/docs/roadmap/remediation.md index 6d306a8..07005f4 100644 --- a/docs/roadmap/remediation.md +++ b/docs/roadmap/remediation.md @@ -134,18 +134,20 @@ Owner: [initial-plan.md](initial-plan.md). Owners: [initial.md](initial.md) and [implementation.md](implementation.md). -- [ ] Replace ownership statements written in future tense in the feature roadmap with +- [x] Replace ownership statements written in future tense in the feature roadmap with links to the existing GoDoc and CLI reference. Clearly identify detailed specifications as the completed design baseline. -- [ ] Label the implementation plan as a completed execution record and explain +- [x] Label the implementation plan as a completed execution record and explain that subsequent fixes were committed after its original completion. -- [ ] Reconcile the statement that definition commands have no `--scope` flag: +- [x] Reconcile the statement that definition commands have no `--scope` flag: they have no built-in configuration-scope selection, but application-declared context selectors may use that name when it does not collide. -- [ ] Preserve the explicitly labeled “At planning time” baseline as historical +- [x] Preserve the explicitly labeled “At planning time” baseline as historical context. Keep diff/catalog and other genuine deferrals visible; completed design records must not become competing current API/CLI references. +**Completion:** Labeled feature specifications and staged instructions as completed history, linked current owners, and recorded later code fixes and selector-name behavior. + ## D-07: correct the current CLI reference Owner: [cli.md](../cli.md).