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

Clarify resource inspection documentation

Browse Source
This commit is contained in:
Eric Rakestraw
2026-11-06 17:59:40 +00:00
parent 20b0f78af2
commit 63e9f0b731
3 changed files with 32 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/consumers/configuration-migration.md
View File

@@ -135,8 +135,10 @@ Replace former maps passed to `BackendSource` in the same way, setting each
inspection paths now address list indexes, for example
`configkit.Keys("profiles").Index(0).Key("model")`. Configuration inspection
and diffs expose resolved values, recorded normalization and provenance.
`InspectProfile` additionally applies backend completion; request preparation
can apply further overrides, so the views are not promised to be identical.
`InspectProfile` reports the selected resolved profile without backend completion.
Use `Prepare` or `PreparedExecution.Details` for completed request settings,
including backend defaults and request overrides; see the
[resource inspection guidance](pkg-promptkit.md#inspect-a-profile-before-prompt-work).
Remove `PromptVersion` and `PromptIdentity.Version` uses and the corresponding
`prompt_version` JSON members. Prompt definition hashes are opaque equality

13
docs/roadmap/remediation.md
View File

@@ -20,11 +20,22 @@ in the reviewed implementation. The
resource-oriented profile result and changed post-handoff null fallback are
deliberately selected compatibility changes, not accidental regressions.
Review evidence below describes the pre-remediation implementation. Completion
markers record the subsequent corrections.
## Findings
### R1. Reconcile Remaining Inspection Contract Documentation [P2]
**Status:** Open. **Affected stages:** 1, 11, and final reconciliation in 12.
**Status:** Complete. **Affected stages:** 1, 11, and final reconciliation in 12.
Completion: package GoDoc now describes the resource JSON/YAML contract and
includes backend inspection in its orientation/ownership summary. A blank
comment separator that hid most of the rendered package overview was repaired.
The migration guide now distinguishes resolved profile inspection from completed
request settings and links to the current consumer guidance. Rendered `go doc`,
current-documentation checks, local links, and whitespace were verified; no
runtime behavior or published release note changed.
**Locations:**