Merged
Size
XL
Change Breakdown
Docs100%
#3223RunEngine readme updates

RunEngine documentation and execution diagrams updated

MA
matt-aitken
·Mar 16, 2026

The RunEngine documentation has been refreshed with a massive ASCII state diagram, updated terminology for regions, and the new token-based wait API.

Developers working with the RunEngine now have access to an accurate, up-to-date architectural reference. A native ASCII flow chart has been added to the documentation, cleanly detailing the precise lifecycle of a run from trigger and queuing to execution and completion. The platform's conceptual documentation has also been aligned with recent system changes: references to self-hosted worker groups have been entirely replaced with regions, and the legacy waitpoint concepts have been swapped out for the new token-based wait APIs. Sections covering deprecated or moved features like throttling and batching have been removed, ensuring the documentation only presents currently supported capabilities.

View Original GitHub DescriptionFact Check
Fact Check Notice: The PR description only mentions adding an ASCII diagram and removing old references, omitting the significant updates to terminology (changing 'worker groups' to 'regions') and the adoption of the new Token-based wait APIs in the documentation.
  • Added a new ascii diagram
  • Removed some old references
© 2026 · via Gitpulse