Update documentation to clarify that stages following prepare will use configuration file copies in work/<session_id>/inputs, not original source files

This commit is contained in:
2026-05-04 07:17:11 -05:00
parent 4252de4b99
commit 1b8fb78926

View File

@@ -28,6 +28,11 @@ Seriatim config contract in `pipeline.yml`:
- use Seriatims documented `match:` format (not the legacy direct mapping style used by older scripts/scaffolds)
- see [`examples/speakers.yml`](examples/speakers.yml) for a concrete `match:` example.
Prepared inputs note:
- `prepare` copies session inputs into the session workdir (`work/<session_id>/inputs`), and downstream stages consume those prepared copies, not the original source files.
- If you edit `speakers.yml`, `autocorrect.yml`, `glossary.yml`, or session input paths after `prepare` has run, rerun `prepare` with `--force` before rerunning downstream stages.
Decoding is strict (`KnownFields(true)`), so unknown YAML fields fail fast.
Example minimal files are available under `examples/`: