docs(flow): document durable pause & resume (ADR-0019) in the flow guide#1698
Merged
Conversation
The flow guide covered ADR-0031 structured control flow but had nothing on the suspend/resume runtime — approval/screen/wait pausing semantics, the resume endpoint, wait-timer auto-resume + cold-boot re-arm, nested pause through subflows (linked runs, #1693), and the runs observability API were all undocumented (ROADMAP P1 "Document Flow-first automation"). Adds a "Durable pause & resume" section: per-node pause/resume table (with the decide-through-approvals-API rule and why direct resume strands the request), the nested-pause chain model with its showcase example pair, the runs endpoints, and the in-memory-history caveat. Node-type table rows for screen/wait/subflow now flag their pause behavior. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The flow guide covered ADR-0031 structured control flow but had nothing on the suspend/resume runtime —
approval/screen/waitpausing semantics, the resume endpoint, wait-timer auto-resume + cold-boot re-arm (#1687), nested pause through subflows (linked runs, #1693), and the runs observability API were all undocumented. This is the core of ROADMAP P1 ("Document Flow-first automation").Adds a Durable pause & resume section to
guides/metadata/flow.mdx:resume(a direct resume strands the pendingsys_approval_request→ record stays locked, later approvals hitDUPLICATE_REQUEST)showcase_project_closure+showcase_closure_signoff)screen/wait/subflownow flag pause behaviorTest plan
pnpm --filter @objectstack/docs buildgreen🤖 Generated with Claude Code