narratio/examples/README.md

Maintained Examples

These files are safe, copyable starting points for Narratio configuration and input structure. Replace placeholder identifiers, storage names, integration URLs, and paths for the target environment. Field meanings and defaults belong in the configuration reference.

Pipeline Configuration

• Minimal pipeline: campaign discovery plus the required WhisperX URL.

• Production-shaped pipeline: S3 storage, publish, external tools, and configured Scriptorium artifacts.

• Production/testing split bundle: explicit conf.d imports, a production default, and selectable production/testing overlays. It also demonstrates canonical-party artifact families and a testing-only disabled artifact. Validate it with:

  narratio config validate --config examples/production-testing/pipeline.yml --campaign-file examples/campaigns/sample-campaign/campaign.yml
  narratio config diff production testing --config examples/production-testing/pipeline.yml --campaign-file examples/campaigns/sample-campaign/campaign.yml
  

  config show and config sources accept the same selectors and remain read-only.

• Full annotated pipeline: every implemented pipeline section with explanatory comments.

• Extraction subset pipeline: a focused Scriptorium artifact consuming only three declared Notarius lanes.

The existing internal/config example test loads and validates each pipeline with the sample campaign and a compatible local- or S3-audio session.

Campaign And Session Configuration

• Sample campaign, its session template, and its adjacent stable inputs provide a complete campaign directory shape.
• Local-audio session and S3-audio session are concrete session files.
• Session template and the campaign-local equivalent demonstrate the narrow placeholder syntax consumed by session init; they are templates, not runtime session files.

Input Fixtures

• Speakers, autocorrect, and glossary show the standalone input shapes.
• The sample campaign references its local speakers, autocorrect, glossary, and canonical party fixture, plus an optional spell-catalog overlay that follows the Notarius v0.6 contract. Narratio derives the players projection from this party source.
• Sample speaker audio is a text placeholder that reserves the expected filename and directory shape. Replace it with a real FLAC file before running transcription.

The examples contain environment-variable names but no credential values. They use fictional campaign content and reserved example domains.