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

Minor documentation cleanup

Browse Source
This commit is contained in:
Eric Rakestraw
2026-07-16 22:31:14 -05:00
parent feb03c3f8e
commit 21888d625f
3 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -5,7 +5,7 @@ with explicit, configurable pipeline modules.
The current implementation reads Seriatim transcript JSON, chunks the source The current implementation reads Seriatim transcript JSON, chunks the source
units, extracts D&D spell-cast artifacts with a Scriptorium-backed LLM runtime, 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 ```sh
OPENROUTER_API_KEY=... \ OPENROUTER_API_KEY=... \
@@ -27,6 +27,6 @@ Useful references:
- [JSON output contract](docs/integrations/json-output.md) - [JSON output contract](docs/integrations/json-output.md)
- [D&D spell artifact contract](docs/integrations/dnd-spell-artifacts.md) - [D&D spell artifact contract](docs/integrations/dnd-spell-artifacts.md)
- [Developer guide](docs/development.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 config](examples/dnd-spells.config.yml)
- [Maintained example input](examples/seriatim-minimal-transcript.json) - [Maintained example input](examples/seriatim-minimal-transcript.json)

5
docs/integrations/dnd-spell-artifacts.md
View File

@@ -19,7 +19,7 @@ the evidence location.
## Output Shape ## 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: structure is:
```text ```text
@@ -28,6 +28,9 @@ structure is:
`spell_casts` must be present. It may be empty when no spell casts are found. `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 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 ## Spell-Cast Fields

7
docs/roadmap/future.md
View File

@@ -44,5 +44,8 @@ future work only.
## Candidate Workspace Work ## Candidate Workspace Work
Workspace storage, cleanup, archival, and reuse candidates are tracked in the - Default-idempotent run behavior with an explicit force override.
[Workspace Future Work](workspace.md) roadmap. - Remote workspace storage.
- Workspace garbage collection.
- Workspace archival policy.
- Cross-machine checkpoint reuse.