Document inspection architecture
This commit is contained in:
@@ -5,16 +5,18 @@ durable development boundaries.
|
||||
|
||||
## System Shape
|
||||
|
||||
Scriptorium is an executable application with three entry paths: CLI `run`, CLI
|
||||
`render`, and the HTTP service started by `serve`. It does not expose a reusable
|
||||
root Go package.
|
||||
Scriptorium is an executable application with four command entry paths: CLI
|
||||
`run`, CLI `render`, CLI `inspect`, and the HTTP service started by `serve`.
|
||||
The `inspect` command has prompt and profile modes. Scriptorium does not expose
|
||||
a reusable root Go package.
|
||||
|
||||
The application consumes
|
||||
[Promptkit v0.9.0](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/consumers/pkg-promptkit.md)
|
||||
through its supported root package. Promptkit owns prompt execution,
|
||||
preparation, source formats, built-in profiles, model-client behavior, and
|
||||
validation. Scriptorium owns application configuration, executable adapters,
|
||||
prepared-run presentation, process behavior, and HTTP deployment policy.
|
||||
prepared-run and definition-inspection presentation, process behavior, and HTTP
|
||||
deployment policy.
|
||||
|
||||
The concrete package inventory is maintained in the
|
||||
[internal overview](../internal/overview.md).
|
||||
@@ -53,7 +55,8 @@ invariants.
|
||||
- `internal/config` owns discovery and strict decoding of Scriptorium
|
||||
application configuration.
|
||||
- `internal/defaults` owns Scriptorium application and HTTP defaults only.
|
||||
- `internal/format` owns deterministic prepared-run text and JSON presentation.
|
||||
- `internal/format` owns deterministic prepared-run and definition-inspection
|
||||
text and JSON presentation.
|
||||
- Promptkit owns framework orchestration and contracts. Its
|
||||
[format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/formats.md)
|
||||
and
|
||||
|
||||
Reference in New Issue
Block a user