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

Move documentation for external integrations into the docs/integrations subfolder

Browse Source
This commit is contained in:
Eric Rakestraw
2026-05-19 09:12:40 -05:00
parent 08b0f4edc5
commit 2b2a314d65
6 changed files with 28 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/documentation/policy.md
View File

@@ -283,6 +283,16 @@ Roadmap docs should clearly distinguish:
Roadmap docs should not be confused with current behavior. Roadmap docs should not be confused with current behavior.
### docs/integrations/
**Audience:** developers, LLM coding agents
Required for projects that depend on external CLIs, APIs, services, protocols, or file formats where the integration contract is important to maintain.
This directory contains concise, versioned reference notes for external integration contracts. It should document only the parts of the external system that this project actually uses.
Use one file per integration where useful.
## Examples Directory ## Examples Directory
Projects with non-trivial configuration or workflows should include `examples/`. Projects with non-trivial configuration or workflows should include `examples/`.

15
docs/integrations/README.md Normal file
View File

@@ -0,0 +1,15 @@
# Integration Documentation Index
## Audience
Developers and LLM coding agents changing Narratio's external integration contracts.
## Scope
Implemented-only reference notes for the external systems Narratio currently integrates with.
## 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.
## Canonical Owner
`docs/integrations/` is the canonical home for external integration reference notes per `docs/documentation/policy.md`.

0
docs/internal/integration-audita.md → docs/integrations/audita.md
View File

0
docs/internal/integration-scriptorium.md → docs/integrations/scriptorium.md
View File

0
docs/internal/integration-seriatim.md → docs/integrations/seriatim.md
View File

6
docs/internal/README.md
View File

@@ -20,9 +20,9 @@ Implementation-accurate contracts for workspace/state, stages, and external adap
- `stage-trim.md`: bounds-driven transcript trimming. - `stage-trim.md`: bounds-driven transcript trimming.
- `stage-analyze.md`: Scriptorium session recap generation. - `stage-analyze.md`: Scriptorium session recap generation.
- `stage-archive.md`: archive upload and current-pointer publish contract. - `stage-archive.md`: archive upload and current-pointer publish contract.
- `integration-audita.md`: Audita adapter invocation/validation contract.
- `integration-seriatim.md`: Seriatim merge/normalize/trim adapter contract. ## External Integration Notes
- `integration-scriptorium.md`: Scriptorium run/render adapter contract. - `../integrations/README.md`: canonical location for external integration contracts (`audita.md`, `seriatim.md`, `scriptorium.md`).
## Canonical Owner ## Canonical Owner
`docs/internal/` is the canonical home for implemented internals per `docs/documentation/policy.md`. `docs/internal/` is the canonical home for implemented internals per `docs/documentation/policy.md`.