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

Document inspection architecture

Browse Source
This commit is contained in:
Eric Rakestraw
2026-08-29 15:16:25 +00:00
parent 6c2541c1ee
commit edca9fbbc1
2 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/internal/overview.md
View File

@@ -11,7 +11,7 @@ public behavior belongs in the linked contracts.
| `internal/adapter/http` | Owns routes, DTOs, strict decoding, limits, Promptkit request/result mapping, public error mapping, and restricted HTTP artifact reading. | [HTTP API](../api.md), [adapter internals](adapters.md), [source internals](sources.md) | | `internal/adapter/http` | Owns routes, DTOs, strict decoding, limits, Promptkit request/result mapping, public error mapping, and restricted HTTP artifact reading. | [HTTP API](../api.md), [adapter internals](adapters.md), [source internals](sources.md) |
| `internal/config` | Discovers and strictly decodes application configuration and applies built-in and CLI precedence. | [configuration contract](../config.md), [adapter internals](adapters.md) | | `internal/config` | Discovers and strictly decodes application configuration and applies built-in and CLI precedence. | [configuration contract](../config.md), [adapter internals](adapters.md) |
| `internal/defaults` | Holds Scriptorium-owned application and HTTP defaults. | [configuration contract](../config.md) | | `internal/defaults` | Holds Scriptorium-owned application and HTTP defaults. | [configuration contract](../config.md) |
| `internal/format` | Formats Promptkit prepared-run values for CLI text or JSON output. | [CLI contract](../cli.md), [adapter internals](adapters.md) | | `internal/format` | Formats Promptkit prepared-run and prompt/profile inspection values for CLI text or JSON output. | [CLI contract](../cli.md), [adapter internals](adapters.md) |
Framework implementation packages are provided by Framework implementation packages are provided by
[Promptkit v0.9.0](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/consumers/pkg-promptkit.md) [Promptkit v0.9.0](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/consumers/pkg-promptkit.md)

13
docs/policy/architecture.md
View File

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