44 lines
1.4 KiB
Markdown
44 lines
1.4 KiB
Markdown
# Internal Documentation Index
|
|
|
|
## Audience
|
|
Developers and coding agents changing Narratio internals.
|
|
|
|
## Scope
|
|
`docs/internal/` documents implemented internal contracts: stage boundaries, manifest/state behavior, artifact resolution, restore behavior, storage boundaries, and workspace invariants.
|
|
|
|
User and operator behavior belongs in:
|
|
- `docs/cli.md`
|
|
- `docs/config.md`
|
|
- `docs/operations.md`
|
|
- `docs/troubleshooting.md`
|
|
|
|
## Pipeline Stage Set
|
|
Canonical stage order from `internal/stage.All()`:
|
|
1. `prepare`
|
|
2. `transcribe`
|
|
3. `merge`
|
|
4. `polish`
|
|
5. `normalize`
|
|
6. `trim`
|
|
7. `analyze`
|
|
8. `publish`
|
|
9. `notify` (placeholder)
|
|
|
|
`notify` is currently a placeholder stage with optional notifier call behavior; it has no persisted pipeline outputs.
|
|
|
|
## Internal Component Docs
|
|
- `adapters.md`: external adapter boundaries and default runtime wiring.
|
|
- `artifacts.md`: canonical source IDs, runtime catalog behavior, and resolution rules.
|
|
- `manifest.md`: session and run manifest contracts.
|
|
- `storage.md`: object-store interface and S3 implementation behavior.
|
|
- `workspace.md`: local session layout, run-local layout, and cleanup guardrails.
|
|
- `command-restore.md`: restore discovery, planning, execution, and reporting.
|
|
- `stage-prepare.md`
|
|
- `stage-transcribe.md`
|
|
- `stage-merge.md`
|
|
- `stage-polish.md`
|
|
- `stage-normalize.md`
|
|
- `stage-trim.md`
|
|
- `stage-analyze.md`
|
|
- `stage-publish.md`
|