docs(workflow-creator): add headless/background stage documentation - #625
Conversation
Update the workflow-creator skill and README to document the new headless stage feature (headless: true on SessionRunOptions). Covers per-SDK implementation details, graph topology transparency, the visible → [N headless] → visible merge pattern, and a new F16 failure mode for invisible headless errors.
Code ReviewDocumentation-only PR adding headless/background stage docs to the workflow-creator skill and README. I verified all technical claims against the implementation in Issues found1. Inconsistency: ## Builtin reference implementations
The SDK ships two builtin workflows that demonstrate production patterns…
- **`ralph`** (`src/sdk/workflows/builtin/ralph/`) — …
- **`deep-research-codebase`** (`src/sdk/workflows/builtin/deep-research-codebase/`) — …
- **`headless-test`** (`.atomic/workflows/headless-test/`) — …Three problems:
Suggestion: either move it under a separate "In-repo example workflows" sub-heading, or describe it inline in the headless section instead of listing it next to shipped builtins (which sets the wrong expectation about what end users will get from the package). 2. Minor — The README example uses 3. Minor — README TOC auto-generation noise The regenerated TOC adds Verified accurate
Style / quality
Tests / coverageN/A — pure docs. The fact that a |
Summary
Documents the new
headless: trueoption onSessionRunOptions, which lets workflow stages run provider SDKs in-process without a tmux window. Updates the workflow-creator skill references and README to cover per-SDK behavior, graph topology semantics, the fan-out/merge pattern, and a new failure mode.Key changes
workflow-creator skill (
SKILL.md)headless/background stageskeywordsReference docs
references/agent-sessions.md— per-SDK headless mode sections for Claude (Agent SDKquery()in-process), Copilot (no-tmux SDK subprocess), and OpenCode (createOpencode()in-process)references/control-flow.md— headless stages are transparent to graph topology:visible → [N headless] → visiblerenders asvisible → visible; includes decision table (headless vs. visible)references/failure-modes.md— new F16 failure mode: headless stage errors produce no graph node; wrapping callbacks with descriptive error context is the recommended mitigationreferences/getting-started.md— new headless stages section; updatedSessionRunOptionstype signature (headless?: boolean); updatedpaneIddocs; addedheadless-testto builtin reference implementationsREADME
Background (headless) stagesrow to the Workflow SDK capabilities tableseed → [3 parallel headless] → mergepatternSessionRunOptionsreference table to includeheadless?: booleanNo breaking changes
This is a documentation-only PR — no runtime behavior is changed.