Skip to content

docs(flow): document durable pause & resume (ADR-0019) in the flow guide - #1698

Merged
os-zhuang merged 1 commit into
mainfrom
docs-flow-durable-pause
Jun 10, 2026
Merged

docs(flow): document durable pause & resume (ADR-0019) in the flow guide#1698
os-zhuang merged 1 commit into
mainfrom
docs-flow-durable-pause

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Summary

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 (#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:

  • per-node pause/resume table — including the operational rule learned in live E2E: decide through the approvals API, never direct resume (a direct resume strands the pending sys_approval_request → record stays locked, later approvals hit DUPLICATE_REQUEST)
  • nested-pause chain model (bubble up / delegate down) with the showcase example pair (showcase_project_closure + showcase_closure_signoff)
  • runs observability endpoints + the in-memory-history caveat
  • node-type table rows for screen/wait/subflow now flag pause behavior

Test plan

  • pnpm --filter @objectstack/docs build green
  • Every documented behavior was browser-verified live against the showcase app earlier today

🤖 Generated with Claude Code

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>
@vercel

vercelBot commented Jun 10, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

ProjectDeploymentActionsUpdated (UTC)
specReadyReadyPreview, CommentJun 10, 2026 4:47pm

Request Review

@github-actionsgithub-actionsBot added documentation Improvements or additions to documentation size/s labels Jun 10, 2026
@os-zhuang
os-zhuang merged commit 8c1e869 into mainJun 10, 2026
12 checks passed
@os-zhuang
os-zhuang deleted the docs-flow-durable-pause branch June 10, 2026 17:01
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationsize/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@os-zhuang