base-layer/commandkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document PromptKit requirements discovery

Browse Source
This commit is contained in:
Eric Rakestraw
2026-10-12 17:26:11 +00:00
parent 3710492d2d
commit d3cbfc4e9a
13 changed files with 179 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/roadmap/deferred.md
View File

@@ -18,14 +18,6 @@ an idea here does not select its syntax, API, priority, or delivery date.
## Deferred capability targets
### PromptKit requirement inspection
PromptKit exposes `Engine.InspectRequirements`, but a standard CommandKit
operation for requirement inspection remains deferred. Its command syntax,
selection behavior, presentation, and readiness semantics have not been
selected. Reassess the owning library's public contract and make those product
choices before planning delivery.
### Comparison extensions
Independent per-side domain selectors and an optional assertion mode remain

17
docs/roadmap/implementation.md
View File

@@ -1,6 +1,6 @@
# Implement PromptKit requirements inspection
Status: in progress; Stages 1 through 5 are complete.
Status: in progress; Stages 1 through 6 are complete.
## Authority and working rules
@@ -423,6 +423,21 @@ Historical release notes and pinned retired plans remain historical evidence;
do not rewrite them as current reference pages. Current canonical docs must not
depend on this temporary plan for their implemented contracts.
**Completed:** Updated the exported API comments in
`integrations/ckprompt/adapters.go`, `command.go`, and `doc.go`; the command and
report contract in `docs/cli.md`; optional callback guidance in
`docs/consumers/guide.md`; module, root, internal, and contributor summaries;
and the composed example README. Removed the delivered capability from
`docs/roadmap/deferred.md` and updated
`docs/roadmap/requirements.md` to describe its historical baseline and point to
the immutable commit that contains the prior deferral. The two example commands
and their semantics match the Stage 5 test and observed output. `gofmt -w
integrations/ckprompt/adapters.go integrations/ckprompt/command.go
integrations/ckprompt/doc.go` and `git diff --check -- '*.md' COPYRIGHT` passed.
A local link and fragment check across nine changed Markdown documents passed;
the stale four-callback and deferred-requirement claim search found no current
documentation claims. No material limitations were encountered.
## Stage 7: Validate the final module boundaries and complete the sprint
**Outcome:** the implemented feature works with its committed dependency graph,

23
docs/roadmap/requirements.md
View File

@@ -1,8 +1,8 @@
# PromptKit requirements inspection
Status: accepted feature roadmap; implementation has not started. Command
Status: accepted feature roadmap; implementation is in progress. Command
placement, public API, caller-variable syntax, and initial presentation are
settled.
settled. The implementation plan records delivery and final validation status.
The [implementation plan](implementation.md) owns the ordered delivery steps and
stage completion evidence.
@@ -35,24 +35,25 @@ is the authority for discovery semantics. Descriptions below explain how
CommandKit will expose that API, rather than establishing a separate discovery
specification.
## Current baseline
## Baseline at roadmap acceptance
Baseline: CommandKit commit
This table records the pre-implementation state at CommandKit commit
[`12b52b3`](https://gitea.maximumdirect.net/eric/CommandKit/src/commit/12b52b3174545d22960c91c3a782a151ab813447).
| Area | Current implementation | Gap to target |
| Area | State then | Gap the roadmap addressed |
| --- | --- | --- |
| Dependencies | ckprompt already adopts PromptKit v0.14.0, ConfigKit v0.7.1, and YAML v4. Modules require Go 1.26.0. | No dependency or toolchain upgrade is needed for this capability. |
| Native capability | PromptKit exposes `Engine.InspectRequirements`, its request, and its structured result. | Adapt this existing public API. |
| Public integration | `Suite[I, S]` provides optional prompt/profile inspection and prompt/profile catalog callbacks. `FromEngine` supplies those four callbacks. | Add an independently optional requirements callback and its engine adapter. |
| Command assembly | `ckprompt.Command` installs available `show` and `list` operations beneath the owned `promptkit` namespace. | Assemble the requirements operation from its own capability. |
| Public integration | The accepted baseline had optional prompt/profile inspection and prompt/profile catalog callbacks. | Add an independently optional requirements callback and its engine adapter. |
| Command assembly | The accepted baseline installed available `show` and `list` operations beneath the owned `promptkit` namespace. | Assemble the requirements operation from its own capability. |
| Invocation infrastructure | Typed selectors, configuration selection, input checks, shared state, diagnostics, and buffered report delivery already exist. | Apply those paths to the new operation. |
| Presentation | Named prompt/profile reports support text and YAML; catalogs use YAML only. | Define a requirements report with the native evidence and discovery context identities. |
The [deferred-work record](deferred.md#promptkit-requirement-inspection) records
this capability's prior deferral. This roadmap takes it up for planning;
the command remains unimplemented. Existing configuration, catalog, and named
definition operations are not prerequisites for enabling requirements inspection.
The former deferral is retained as an
[immutable historical record](https://gitea.maximumdirect.net/eric/CommandKit/src/commit/ee038df530bfd3518906dc77e8e8f55eef237dda/docs/roadmap/deferred.md).
This roadmap takes the capability up for delivery. Existing configuration,
catalog, and named definition operations are not prerequisites for requirements
inspection.
## Target ownership and package boundaries