Minor documentation cleanup
This commit is contained in:
@@ -5,7 +5,7 @@ with explicit, configurable pipeline modules.
|
||||
|
||||
The current implementation reads Seriatim transcript JSON, chunks the source
|
||||
units, extracts D&D spell-cast artifacts with a Scriptorium-backed LLM runtime,
|
||||
and writes JSON output plus diagnostics for each run.
|
||||
and writes JSON output plus diagnostics when enabled.
|
||||
|
||||
```sh
|
||||
OPENROUTER_API_KEY=... \
|
||||
@@ -27,6 +27,6 @@ Useful references:
|
||||
- [JSON output contract](docs/integrations/json-output.md)
|
||||
- [D&D spell artifact contract](docs/integrations/dnd-spell-artifacts.md)
|
||||
- [Developer guide](docs/development.md)
|
||||
- [Internal architecture docs](docs/internal/overview.md)
|
||||
- [Internal implementation docs](docs/internal/overview.md)
|
||||
- [Maintained example config](examples/dnd-spells.config.yml)
|
||||
- [Maintained example input](examples/seriatim-minimal-transcript.json)
|
||||
|
||||
@@ -19,7 +19,7 @@ the evidence location.
|
||||
|
||||
## Output Shape
|
||||
|
||||
`lanes/spells.json` is a JSON object with one required top-level array. Its
|
||||
The extractor payload is a JSON object with one required top-level array. Its
|
||||
structure is:
|
||||
|
||||
```text
|
||||
@@ -28,6 +28,9 @@ structure is:
|
||||
|
||||
`spell_casts` must be present. It may be empty when no spell casts are found.
|
||||
When multiple chunk results are combined, spell casts remain in chunk order.
|
||||
When the payload is written as durable output, its logical path is derived from
|
||||
the configured artifact lane ID as defined by the
|
||||
[JSON output contract](json-output.md#output-payload-files).
|
||||
|
||||
## Spell-Cast Fields
|
||||
|
||||
|
||||
@@ -44,5 +44,8 @@ future work only.
|
||||
|
||||
## Candidate Workspace Work
|
||||
|
||||
Workspace storage, cleanup, archival, and reuse candidates are tracked in the
|
||||
[Workspace Future Work](workspace.md) roadmap.
|
||||
- Default-idempotent run behavior with an explicit force override.
|
||||
- Remote workspace storage.
|
||||
- Workspace garbage collection.
|
||||
- Workspace archival policy.
|
||||
- Cross-machine checkpoint reuse.
|
||||
|
||||
Reference in New Issue
Block a user