Document configuration outcomes and release handoff

This commit is contained in:
2026-11-16 18:08:33 +00:00
parent 20d2924338
commit 8a22dd6a4f
6 changed files with 109 additions and 28 deletions

View File

@@ -34,9 +34,13 @@ Select either integration with `go get go.maximumdirect.net/ckconfig@v0.7.0`
or `go get go.maximumdirect.net/ckprompt@v0.7.0`. The published integrations
select core v0.6.0. ckprompt v0.7.0 selects ckconfig v0.7.0, which includes
`AdaptDiagnostics`.
They build independently against these released dependencies; a local workspace
is optional for development. Published ckconfig v0.3.0 also uses ConfigKit v1.1.0
and does not compose with ckprompt v0.2.0's earlier ConfigKit dependency.
Those published versions build independently against their released dependencies.
The current checkout of ckprompt uses an API added to local ckconfig after
v0.7.0, so it requires the aligned workspace until ckconfig v0.8.0 is published
and ckprompt updates its dependency. See the
[release handoff](../roadmap/future.md#configuration-outcome-release-handoff).
Published ckconfig v0.3.0 also uses ConfigKit v1.1.0 and does not compose with
ckprompt v0.2.0's earlier ConfigKit dependency.
ConfigKit v1.2.0 adds fields to `Input` and `LayeredOptions`, so application
loaders should use keyed struct literals when constructing them. ConfigKit's
@@ -321,6 +325,10 @@ acquired evidence. See `EffectiveWriter` and `ExplanationReader` in the
[ckconfig GoDoc](../../integrations/ckconfig/contracts.go) for the provider boundary.
`ckconfig.AdaptDiagnostics` captures native diagnostic presentation evidence
for applications providing their own ConfigKit-backed CLI integration.
[`ckconfig.ClassifyConfigurationError`](../../integrations/ckconfig/errors.go)
provides the standard CLI outcome classification for ConfigKit errors; callers
construct their own outcomes, explanations, and causes. The [CLI reference](../cli.md#configuration-failure-classification)
describes the standard commands' status behavior.
Set `Scope.Features.Overrides` only when the loader passes
`Selection.Overrides` to ConfigKit as part of its normal load. The integration
parses CLI records but cannot add them to an already-loaded result. The