30 lines
1.6 KiB
Markdown
30 lines
1.6 KiB
Markdown
# Internal Documentation Index
|
|
|
|
## Audience
|
|
Developers and LLM coding agents changing Narratio internals.
|
|
|
|
## Scope
|
|
Implementation-accurate contracts for workspace/state, manifests, stages, artifact resolution, adapter boundaries, and restore command behavior.
|
|
|
|
## Component Docs
|
|
- `adapters.md`: external adapter map, runtime wiring, and boundary ownership.
|
|
- `storage.md`: remote storage backend contracts and object-store invariants.
|
|
- `manifest.md`: session/run manifest schemas, lifecycle transitions, and persistence semantics.
|
|
- `artifacts.md`: built-in artifact registry, runtime artifact catalog, and source-resolution behavior.
|
|
- `workspace.md`: local state model, manifests, run-local layout, promotion, and cleanup invariants.
|
|
- `command-restore.md`: restore command discovery/planning/execution/reporting contract.
|
|
- `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`: dependency-ordered Scriptorium artifact generation for selected configured artifacts.
|
|
- `stage-archive.md`: archive upload and current-pointer publish contract.
|
|
|
|
## External Integration Notes
|
|
- `../integrations/README.md`: canonical location for external integration contracts (`audita.md`, `seriatim.md`, `scriptorium.md`).
|
|
|
|
## Canonical Owner
|
|
`docs/internal/` is the canonical home for implemented internals per `docs/documentation/policy.md`.
|