Limit inspection work during PromptKit adoption
This commit is contained in:
@@ -23,6 +23,13 @@ smoke diagnostics, are deferred to a separate roadmap. It does not add HTTP
|
||||
operations for those capabilities or introduce continuation, coordination,
|
||||
prepared-handle workflows, or prepared-content capture.
|
||||
|
||||
CommandKit adoption (`go.maximumdirect.net/commandkit`), including the
|
||||
`ckconfig` and `ckprompt` integrations, is planned after this migration and
|
||||
belongs to a separate roadmap. Its standardized operator interfaces are
|
||||
expected to replace Scriptorium's current inspection interfaces. This roadmap
|
||||
keeps those existing commands in maintenance-only scope and adds no
|
||||
CommandKit dependencies or advance integration scaffolding.
|
||||
|
||||
## Baseline And Target
|
||||
|
||||
The reviewed Scriptorium baseline is
|
||||
@@ -111,17 +118,25 @@ version selector and the corresponding version members from the CLI and HTTP
|
||||
request, response, inspection, and report contracts where they exist. Do not
|
||||
accept a legacy version selector and then ignore it.
|
||||
|
||||
Keep the existing `config` and `inspect` commands functional and accurate
|
||||
against the selected upstream APIs. Limit inspection work to required import,
|
||||
API, type, selector, and semantic adaptations. Do not expand capabilities,
|
||||
redesign command syntax or report presentation, or build reusable inspection
|
||||
abstractions for the later CommandKit adoption. Necessary output changes should
|
||||
be the smallest accurate adaptation, with proportionate test and documentation
|
||||
updates.
|
||||
|
||||
Continue to distinguish framework configuration, resolved resources, and
|
||||
request preparation. Framework configuration inspection reports the
|
||||
upstream captured result, with native provenance, normalization, and
|
||||
redaction where currently used. Profile inspection reports the resolved
|
||||
profile, preserving unset versus explicitly supplied values, rather than
|
||||
reconstructing backend-completed settings. Render shows request-completed
|
||||
settings. Use native reports or writers when their content matches the
|
||||
existing interface's purpose; retain focused projections where Scriptorium
|
||||
owns the format or disclosure boundary. In particular, captured prompt
|
||||
messages becoming available upstream is not reason to add them automatically
|
||||
to existing prompt inspection output.
|
||||
settings. Reuse existing native writers and make only required adjustments to
|
||||
local inspection projections. Preserve existing disclosure boundaries;
|
||||
captured prompt messages becoming available upstream is not reason to add them
|
||||
automatically to existing prompt inspection output. Adoption of CommandKit's
|
||||
report formats and disclosure behavior belongs to the later roadmap.
|
||||
|
||||
PromptKit owns preparation, provider calls, retries, capacity, validation,
|
||||
and repair. Preserve the configured shared server engine and established
|
||||
@@ -182,8 +197,11 @@ serve the application independently of wire compatibility.
|
||||
the repository so validation does not require cloning external repositories.
|
||||
- **Adapt the existing interfaces.** Update CLI argument mapping,
|
||||
formatters, captured framework source records and list-index explanation
|
||||
paths, HTTP DTOs, and terminal report projections. Keep explicit zero
|
||||
overrides and optional-value presence. Check that the restricted HTTP
|
||||
paths, HTTP DTOs, and terminal report projections. Inspection changes are
|
||||
limited to the maintenance-only adaptations above; inspection formatter
|
||||
cleanup, presentation improvements, and CommandKit command standardization
|
||||
are outside this migration. Keep explicit zero overrides and optional-value
|
||||
presence. Check that the restricted HTTP
|
||||
artifact reader transfers ownership of returned artifacts and bytes under
|
||||
the new public contract without changing Scriptorium's containment policy.
|
||||
Preserve established CLI outcomes outside the intentional cutover changes.
|
||||
@@ -205,8 +223,11 @@ serve the application independently of wire compatibility.
|
||||
resolution. Document the new HTTP contract directly in the
|
||||
[API reference](../api.md) and update its maintained examples. Update the
|
||||
canonical configuration, CLI, subprocess, and internal references where
|
||||
their implementation changes. Refresh current contributor and
|
||||
architecture references to the selected upstream release,
|
||||
their implementation changes. For existing inspection commands, correct
|
||||
documentation affected by required API and semantic changes without expanding
|
||||
their operator workflows or documenting future CommandKit behavior as current.
|
||||
Refresh current contributor and architecture references to the selected
|
||||
upstream release,
|
||||
leaving historical release records intact. Record release impact as
|
||||
an intentional incompatible change under the
|
||||
[release policy](../policy/release.md#versioning-and-compatibility); this
|
||||
@@ -221,6 +242,10 @@ serve the application independently of wire compatibility.
|
||||
editing the installation's source configuration. Include unrelated YAML
|
||||
outside the authored import selections to verify that entry-file discovery
|
||||
does not treat an entire repository as framework configuration.
|
||||
Update affected inspection tests to cover required adaptations, accurate
|
||||
optional-value handling, and preserved disclosure boundaries. Reuse existing
|
||||
coverage and keep new inspection checks focused on migration regressions;
|
||||
do not build a broader report or command suite ahead of CommandKit adoption.
|
||||
Protect behavior likely to regress in this cutover:
|
||||
explicit zero overrides, shared backend admission, timeout attribution,
|
||||
safe output, and unchanged HTTP artifact policy. No live inference is
|
||||
|
||||
Reference in New Issue
Block a user