Establish canonical documentation links

This commit is contained in:
2026-07-05 02:56:57 +00:00
parent aabd89aea7
commit d5d7a222a4
7 changed files with 17 additions and 17 deletions

View File

@@ -26,9 +26,9 @@ This command renders the prepared prompt and effective runtime settings without
- [Operations guide](docs/operations.md) - [Operations guide](docs/operations.md)
- [Troubleshooting](docs/troubleshooting.md) - [Troubleshooting](docs/troubleshooting.md)
- [Go library package](docs/consumers/pkg-scriptorium.md) - [Go library package](docs/consumers/pkg-scriptorium.md)
- [HTTP API integration](docs/integrations/http-api.md) - [HTTP API reference](docs/api.md)
- [OpenAI-compatible chat integration](docs/integrations/openai-compatible-chat.md) - [OpenAI-compatible chat integration](docs/integrations/openai-compatible-chat.md)
- [Narratio subprocess integration](docs/integrations/narratio.md) - [Subprocess integration](docs/integrations/subprocess.md)
- [Architecture policy](docs/policy/architecture.md) - [Architecture policy](docs/policy/architecture.md)
## Examples ## Examples

View File

@@ -1,14 +1,14 @@
# HTTP API Integration # HTTP API Reference
## Scope ## Scope
This document defines the implemented inbound HTTP contract for Scriptorium. This document is the canonical public HTTP contract for Scriptorium.
Current scope is only: Current scope is only:
- `POST /v1/runs` - `POST /v1/runs`
For CLI behavior, see the [CLI reference](../cli.md). For CLI behavior, see the [CLI reference](cli.md).
## Endpoint ## Endpoint

View File

@@ -20,8 +20,8 @@ go run ./cmd/scriptorium render \
Integration references: Integration references:
- [HTTP contract](integrations/http-api.md) - [HTTP API reference](api.md)
- [Narratio subprocess contract](integrations/narratio.md) - [Subprocess integration](integrations/subprocess.md)
## Common Argument Rules ## Common Argument Rules

View File

@@ -328,5 +328,5 @@ examples/schemas/dnd/structured_events.schema.json
## Integration References ## Integration References
- [Inbound HTTP contract](integrations/http-api.md) - [HTTP API reference](api.md)
- [Outbound OpenAI-compatible contract](integrations/openai-compatible-chat.md) - [Outbound OpenAI-compatible contract](integrations/openai-compatible-chat.md)

View File

@@ -3,7 +3,7 @@
Scriptorium can be used by consumers through three implemented surfaces: Scriptorium can be used by consumers through three implemented surfaces:
- CLI commands, documented in [CLI reference](../cli.md). - CLI commands, documented in [CLI reference](../cli.md).
- HTTP `POST /v1/runs`, documented in [HTTP API integration](../integrations/http-api.md). - HTTP `POST /v1/runs`, documented in [HTTP API reference](../api.md).
- Go package `gitea.maximumdirect.net/eric/scriptorium`, documented in [pkg-scriptorium](pkg-scriptorium.md). - Go package `gitea.maximumdirect.net/eric/scriptorium`, documented in [pkg-scriptorium](pkg-scriptorium.md).
The Go package is the typed in-process API. It prepares prompts, runs prompts, accepts file or inline artifacts, supports per-request execution overrides, and exposes stable public errors for `errors.Is`. The Go package is the typed in-process API. It prepares prompts, runs prompts, accepts file or inline artifacts, supports per-request execution overrides, and exposes stable public errors for `errors.Is`.

View File

@@ -1,14 +1,14 @@
# Narratio Subprocess Integration # Subprocess Integration
## Purpose ## Purpose
This document defines the supported subprocess contract for Narratio invoking Scriptorium through the public CLI. This document defines the supported subprocess contract for downstream applications invoking Scriptorium through the public CLI.
This is a CLI contract, not an internal Go package integration. This is a CLI contract, not an internal Go package integration.
## Supported Commands ## Supported Commands
Narratio should invoke: Downstream applications should invoke:
- `scriptorium run` - `scriptorium run`
- `scriptorium render` - `scriptorium render`
@@ -37,7 +37,7 @@ scriptorium render \
--format json --format json
``` ```
Narratio may add: Callers may add:
- `--config <path>` - `--config <path>`
- `--profile <profile_id>` - `--profile <profile_id>`
@@ -47,7 +47,7 @@ Narratio may add:
## Config And Directory Behavior ## Config And Directory Behavior
Narratio can rely on resolved app config or pass explicit paths. Callers can rely on resolved app config or pass explicit paths.
- default config search order: - default config search order:
1. `/usr/local/etc/scriptorium/config.yml` 1. `/usr/local/etc/scriptorium/config.yml`
@@ -63,7 +63,7 @@ Profile selection follows runner behavior:
2. prompt `default_profile` 2. prompt `default_profile`
3. error if neither is available 3. error if neither is available
Narratio should treat prompt/profile IDs as deployment configuration, not hardcoded logic. Callers should treat prompt/profile IDs as deployment configuration, not hardcoded logic.
## Input And Variable Contract ## Input And Variable Contract
@@ -91,7 +91,7 @@ Narratio should treat prompt/profile IDs as deployment configuration, not hardco
- stdout: prepared-run output unless `--out` is used - stdout: prepared-run output unless `--out` is used
- stderr: errors - stderr: errors
Narratio should capture stdout and stderr separately. Callers should capture stdout and stderr separately.
## Exit Status Contract ## Exit Status Contract

View File

@@ -176,7 +176,7 @@ Relevant links:
- [CLI reference](cli.md) - [CLI reference](cli.md)
- [Configuration reference](config.md) - [Configuration reference](config.md)
- [HTTP API integration](integrations/http-api.md) - [HTTP API reference](api.md)
## Prompt Template Render Failures ## Prompt Template Render Failures