diff --git a/docs/roadmap/commandkit-notepad.md b/docs/roadmap/commandkit-notepad.md index f53266c..80cec83 100644 --- a/docs/roadmap/commandkit-notepad.md +++ b/docs/roadmap/commandkit-notepad.md @@ -60,6 +60,26 @@ If a required shared capability is missing, discuss an upstream request before designing a local substitute. Application-specific behavior still belongs in Scriptorium. +### Initial capability set + +Decision recorded 2026-11-19: include configuration comparison, provider smoke +tests, and shell completion in the initial migration, alongside application and +PromptKit configuration scopes, resource inventories and inspection, +requirements discovery, and concrete request validation. + +Use the existing upstream capabilities. Configuration comparison should cover +both application and PromptKit scopes, with independent selections for each +side. Provider smoke tests run when explicitly invoked; including them does not +make them startup checks or release prerequisites. Document provider usage and +the distinction between successful diagnostic execution and positive findings. +Shell completion should use upstream command, flag, static-value, and path +completion, with appropriate hints for application-owned inputs. Dynamic +completion of installed resource names is a separate possible enhancement. + +Application-specific wiring remains to be designed, but inclusion of these +three capabilities is settled. Prepared-request preview and the future of +`render` remain a separate discussion below. + ## Upstream baseline The initial review covered CommandKit **v0.7.0**, ckconfig **v0.9.0**, and @@ -85,20 +105,7 @@ not requirements to reproduce during migration. ## Open decisions -### 1 Initial capability set - -The starting proposal is to expose application and PromptKit configuration -scopes, all resource inventories and inspection, requirements discovery, and -concrete request validation through the native integrations. - -Decide whether configuration comparison, provider smoke tests, and shell -completion all belong in the initial migration. Prepared-request preview is -addressed separately below. These capabilities already exist upstream; the -question is initial Scriptorium scope and wiring, not whether to reimplement -them. Provider smoke tests explicitly contact services, and inference tests can -incur model usage. - -### 2 Generation output and process outcomes +### 1 Generation output and process outcomes The starting proposal is to keep generated artifact bytes easy to consume, with execution metadata separately available. CommandKit supports both raw @@ -122,7 +129,7 @@ responsibilities. Decide their mapping to the CommandKit invocation context and PromptKit operation timeout, separately from the standard per-attempt timeout flag. -### 3 Prepared-request preview and the existing render command +### 2 Prepared-request preview and the existing render command Upstream `promptkit show prepared` overlaps Scriptorium's `render` command. Prefer one preparation path and the native prepared report. @@ -133,7 +140,7 @@ file output. Retaining the old name or custom report solely for compatibility is already ruled out. Review associated application defaults, including the current render-format setting, when deciding the final interface. -### 4 Configuration selection and namespace experience +### 3 Configuration selection and namespace experience Use consistent application configuration and PromptKit source selection across generation, inspection, requirements, and previews. Application-only @@ -150,7 +157,7 @@ namespace-filtered and all-namespace inventory views. Begin with upstream behavior; identify any unmet collection-navigation need before adding local conventions. Collection discovery itself does not need redesign for CommandKit. -### 5 Native reports and executable consumer needs +### 4 Native reports and executable consumer needs Adopt native inspection reports as the starting point. Standard prompt inspection includes captured prompt messages, unlike the current Scriptorium @@ -176,7 +183,7 @@ real request and may read input artifacts and check relevant credentials; discovery must work before those artifacts exist. Neither guarantees a future generation will succeed. -### 6 Application commands and standard request flags +### 5 Application commands and standard request flags Decide the final generation command operands and application-specific flags around the reusable ckprompt request flag groups. Use their standard names,