Complete documentation rebuild
This commit is contained in:
24
docs/internal/README.md
Normal file
24
docs/internal/README.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# Internal Documentation Index
|
||||
|
||||
## Audience
|
||||
Developers and LLM coding agents changing Narratio internals.
|
||||
|
||||
## Scope
|
||||
Implementation-accurate contracts for workspace/state, stages, and external adapter boundaries.
|
||||
|
||||
## Component Docs
|
||||
- `workspace.md`: local state model, manifests, run-local layout, promotion, and cleanup invariants.
|
||||
- `stage-prepare.md`: input materialization and provenance capture.
|
||||
- `stage-transcribe.md`: WhisperX transcript generation.
|
||||
- `stage-merge.md`: Seriatim normalization + merge.
|
||||
- `stage-polish.md`: Audita transcript polishing.
|
||||
- `stage-normalize.md`: post-polish normalization.
|
||||
- `stage-trim.md`: bounds-driven transcript trimming.
|
||||
- `stage-analyze.md`: Scriptorium session recap generation.
|
||||
- `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.
|
||||
- `integration-scriptorium.md`: Scriptorium run/render adapter contract.
|
||||
|
||||
## Canonical Owner
|
||||
`docs/internal/` is the canonical home for implemented internals per `docs/documentation/policy.md`.
|
||||
Reference in New Issue
Block a user