eric/promptkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Reconcile reliable execution documentation

Browse Source
This commit is contained in:
Eric Rakestraw
2026-09-23 17:29:12 +00:00
parent 1cc754c29e
commit cef8524b31
14 changed files with 152 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/roadmap/reliable-execution.md
View File

@@ -1,9 +1,10 @@
# Reliable And Observable Execution
**Status:** Accepted feature scope; not implemented. This document owns the
target end state and approved policy choices. The companion
[implementation plan](implementation.md) owns implementation steps and concrete
API and algorithm decisions.
**Status:** Implemented in source; not yet released. This document records the
accepted target and approved policy choices. The companion
[implementation plan](implementation.md) records implementation steps and
concrete API and algorithm decisions. Current contracts are owned by public
GoDoc and the linked consumer and integration documentation.
## Purpose
@@ -19,20 +20,21 @@ observations, shared capacity, and consumer evidence belong together because
they describe the same execution lifecycle. Licensing was handled separately.
Audita motivates the work but does not define an application-specific API.
## Existing Foundations
## Foundations At Planning Time
Promptkit already provides structural output validation and bounded repair,
prepared execution, engine-local backend capacity, run metadata, aggregate token
usage, and typed provider-status and capacity errors. Operational errors do not
return partial run results. The built-in client has no transient retry loop,
and existing integer usage fields do not distinguish missing reports from zero.
At the time this scope was accepted, Promptkit provided structural output
validation and bounded repair, prepared execution, engine-local backend
capacity, run metadata, aggregate token usage, and typed provider-status and
capacity errors. Operational errors did not return partial run results. The
built-in path had no transient retry loop, and existing integer usage fields
did not distinguish missing reports from zero.
The current contracts remain owned by public GoDoc, the
The implemented contracts are owned by public GoDoc, the
[consumer guide](../consumers/pkg-promptkit.md), and the
[provider integration contract](../integrations/openai-compatible-chat.md).
The [capacity document](../internal/capacity.md) and
[runner document](../internal/runner.md) describe the existing implementation.
This roadmap does not redefine those documents as already implementing new work.
This historical baseline does not override their current-state descriptions.
## Target End State