Files
promptkit/docs/roadmap/next-release-considerations.md

87 lines
4.5 KiB
Markdown

# Feature Considerations Before The Next Release
Status: items 1 and 2 record accepted design decisions. Review these items before
the next release; this document does not authorize implementation or commit either
item to that release. Implemented schema support is documented in the
[format reference](../formats.md#schemas).
## 1. Enable One Structured-Output Repair Attempt By Default
**Accepted:** default to one repair attempt for every validation mode that
supports repair. This gives structurally invalid or empty output one automatic
correction opportunity without requiring each consumer to opt in.
| Validation mode | Default repair attempts |
| --- | ---: |
| `none` | 0 |
| `basic` | 1 |
| `json` | 1 |
| `json_schema` | 1 |
Use a presence-aware public `RepairAttempts` field: omission selects the mode's
default; explicit zero disables repairs. Retain explicit budgets of two or three
for eligible modes. Keep the existing rejection of positive budgets for `none`.
Choose one rather than two as the default; consumers can opt into another
correction opportunity when appropriate for their workloads.
Apply defaults after ConfigKit composition, preserving explicit values. Execution
and inspection use the resolved concrete budget. Apply the same mode defaults to
omitted runtime output-contract budgets; runtime contracts still replace the
configured contract completely. Prepared execution retains its resolved budget.
Implementation planning must specify the presence-aware Go shape and migration
from the current integer field, and cover omission versus explicit zero across
configuration, typed helpers, and runtime contracts. Document that repair runs
only after failed validation and can add generation latency and usage. Existing
repair accounting, exhaustion, cancellation, and transient-retry semantics remain
unchanged; the change does not promise successful correction.
## 2. Place Configuration Under A Root-Level `promptkit` Key
**Accepted:** move all PromptKit-owned configuration beneath the fixed root-level
`promptkit` key. This gives applications a distinct configuration section for
PromptKit alongside their other settings. Do not add a configurable mounting key.
The resolved structure includes `promptkit.backends`, `promptkit.profiles`,
`promptkit.prompts`, `promptkit.collections`, and `promptkit.schema_root`.
Collection-local fields remain inside their collection. ConfigKit-owned source
headers and directives retain their native semantics and locations; they do not
automatically move inside `promptkit`.
Make a clean breaking migration with one canonical resolved location. Do not
support legacy root-level resource locations through aliases, automatic detection,
or a second merge/precedence pass. Runtime resource IDs and namespace selection
remain unchanged; the configuration wrapper is not part of a resource ID.
Preserve convenient standalone files. Individual resource files can still begin
with `id`, and collection files can still contain local `prompts`, `profiles`,
`backends`, and `schema_root` fields without a `promptkit` wrapper. Native ConfigKit
import destinations and PromptKit source helpers mount those fragments at the
appropriate nested location. This is fragment composition, not support for two
alternative application configuration layouts. Source-relative resource context
must continue to follow the effective contributing field.
PromptKit owns validation of its section, not sibling application settings.
Implementation planning must verify the ConfigKit loading boundary so that
unrelated application sections can coexist without PromptKit interpreting or
rejecting their contents. Keep field validation within PromptKit's section.
Implementation planning must cover:
- Updating bundled underlays, source helpers, import destinations, identity
registrations, normalization, and validation to the new paths using ordinary
ConfigKit composition.
- Reflecting nested paths in configuration inspection and diagnostics while
preserving resource inspection and runtime IDs.
- Migration guidance for application documents and explicit import destinations,
including schema roots; standalone fragments should not need extra wrappers.
- Focused coverage for sibling application settings, mounted collections and
resources, default overlays, and source-relative message/schema resolution.
No product decisions remain open for these two items. Concrete API shapes and
loader integration remain implementation-planning work.
## Further Candidates
Append additional pre-release considerations here as they arise.