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

Rewrite integration documentation and verify maintained examples

Browse Source
This commit is contained in:
Eric Rakestraw
2026-05-23 13:01:17 +00:00
parent 0299b128cf
commit 0d02cb9fa0
4 changed files with 156 additions and 160 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/integrations/README.md
View File

@@ -1,15 +1,19 @@
# Integration Documentation Index
# Integrations Index
## Audience
Developers and LLM coding agents changing Narratio's external integration contracts.
Developers and coding agents changing Narratio's external integration boundaries.
## Scope
Implemented-only reference notes for the external systems Narratio currently integrates with.
`docs/integrations/` is the implementation-level reference for downstream tool adapter contracts.
## Integration Docs
- `audita.md`: Audita adapter invocation and validation contract.
- `seriatim.md`: Seriatim normalize/merge/trim adapter contract.
- `scriptorium.md`: Scriptorium run/render adapter contract.
These docs cover what Narratio expects from external tools and what each adapter guarantees back to stage code.
## Canonical Owner
`docs/integrations/` is the canonical home for external integration reference notes per `docs/policy/documentation.md`.
## Integration Contracts
- `audita.md`: transcript polishing adapter (`audita process`).
- `seriatim.md`: merge/normalize/trim adapter (`seriatim`).
- `scriptorium.md`: artifact run/render adapter (`scriptorium run|render`).
## Related Canonical Docs
- `docs/config.md`: operator-facing configuration reference.
- `docs/internal/adapters.md`: shared adapter boundary and runner wiring.
- `docs/internal/stage-*.md`: stage-specific integration usage.