Podcast Pipeline Documentation

This site follows the Diataxis framework so content is grouped by tutorials, how-to guides, reference material, and explanations.

Diataxis sections

• Tutorials: step-by-step lessons for getting started.

• How-to guides: task-focused guides for specific outcomes.

• Reference: technical reference material and APIs.

• Explanation: background material, architecture notes, and rationale.

• Decisions: architecture decisions and rationale.

Sections

• Tutorials
  • Episode workflow: init → ingest → draft → review → pick
  • Getting started
  • Learning path
• How-to guides
  • Update documentation
  • Common tasks
• Reference
  • API references
• Explanation
  • Architecture
• Decisions
  • Docs stack decision: Sphinx + MyST

Local preview

Run a live preview with:

just docs

Or build static HTML with:

just docs-build

The preview runs at http://127.0.0.1:8000 and static output lands in docs/_build/html/.