From edca9fbbc1253d08a6b9a634e2974e5773908510 Mon Sep 17 00:00:00 2001 From: Eric Rakestraw Date: Sat, 29 Aug 2026 15:16:25 +0000 Subject: [PATCH] Document inspection architecture --- docs/internal/overview.md | 2 +- docs/policy/architecture.md | 13 ++++++++----- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/internal/overview.md b/docs/internal/overview.md index 71530ee..a7b3a3d 100644 --- a/docs/internal/overview.md +++ b/docs/internal/overview.md @@ -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/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/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 [Promptkit v0.9.0](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/consumers/pkg-promptkit.md) diff --git a/docs/policy/architecture.md b/docs/policy/architecture.md index f796bc9..0c72edd 100644 --- a/docs/policy/architecture.md +++ b/docs/policy/architecture.md @@ -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