mirror of
https://github.com/run-llama/workflows-py.git
synced 2026-07-16 05:31:56 -04:00
64c0f58f56
The workflows docs had a solid API tour, but several pages taught stale or partial contracts: custom start events carried runtime objects, human-in-the-loop examples used older event injection patterns, retry policy docs omitted the durable jitter seed, and the top-level guide did not give readers a clear path through events, state, resources, streaming, validation, and testing. This tightens the core workflow docs around the contracts users actually need: - reshapes the landing guide around event flow, validation, and when to use typed returns, `list[E]`, `ctx.send_event`, state, and resources - adds a testing guide for `WorkflowTestRunner`, streamed events, final results, and context state assertions - clarifies the boundary between serializable state, durable snapshots, and injected resources - updates streaming docs for `WorkflowHandler`, single-consumer streams, and abnormal workflow termination events - fixes advanced pages for custom start/stop events, human-in-the-loop resume, retry policy authoring, workflow drawing, and free-function step registration - corrects stale imports and commands for workflow server docs - moves testing before observability/deployment/client in the sidebar so readers hit local development guidance before server/client material