Getting started

Follow this guide to run the docs project locally and validate your basic Idum setup.

Prerequisites

• Python 3.11 or newer.
• Access to your workflow definitions and worker process.
• A queue backend configured for your environment.

Run locally

1. Install dependencies with uv sync.
2. Start the docs site using uv run mkdocs serve.
3. Open http://localhost:8000 and verify the docs navigation.

First workflow checklist

!!! note Prefer idempotent step handlers from day one to simplify retries and recovery.

• Define a workflow with explicit step names and retry policy.
• Implement workers that handle each step idempotently.
• Publish jobs to the queue with a unique execution identifier.
• Confirm completion and inspect failures in your monitoring pipeline.