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

Document consumer safety and offline execution

Browse Source
This commit is contained in:
Eric Rakestraw
2026-07-29 14:13:52 +00:00
parent 086cf0fc86
commit b462153483
8 changed files with 171 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/roadmap/documentation.md
View File

@@ -106,21 +106,25 @@ documented behavior whose compatibility risk warrants durable coverage.
Move consumer-relevant security boundaries to the places where consumers will
encounter them and add one representative execution workflow.
- [ ] Explain in public GoDoc and the consumer guide that the default file
- [x] Explain in public GoDoc and the consumer guide that the default file
artifact reader accepts unrestricted caller-selected paths.
- [ ] Make clear that Promptkit does not impose an application root, inbound
- [x] Make clear that Promptkit does not impose an application root, inbound
request-size policy, or untrusted-input security boundary.
- [ ] Explain that rendered messages, artifact bodies, raw model output, and
- [x] Explain that rendered messages, artifact bodies, raw model output, and
validation details may be sensitive even when credentials are redacted.
- [ ] Clarify the responsibilities of injected artifact readers and model
- [x] Clarify the responsibilities of injected artifact readers and model
clients for cancellation, copying, logging, and secret handling.
- [ ] Add a maintained offline `Run` example using an injected deterministic
- [x] Add a maintained offline `Run` example using an injected deterministic
model client, without credentials, live network access, or paid calls.
- [ ] Link the consumer guide to the execution example and keep embedded
- [x] Link the consumer guide to the execution example and keep embedded
snippets smaller than the maintained artifact.
- [ ] Decide whether the existing preparation example should remain separate
- [x] Decide whether the existing preparation example should remain separate
or share reusable fixtures without obscuring either workflow.
The preparation and execution examples remain separate, self-contained
workflows. Each keeps its own small prompt fixture so consumers can copy or run
one example without depending on the other.
**Gate:** Both preparation and execution have complete, secret-free,
deterministic consumer examples, and the consumer guide exposes the important
filesystem and data-sensitivity boundaries without leaking internal mechanics.