Skip to content

docs(sdk): document background delegation - #725

Open
KirschBluteX wants to merge 3 commits into
OpenHands:mainfrom
KirschBluteX:docs/background-delegation-2047
Open

docs(sdk): document background delegation#725
KirschBluteX wants to merge 3 commits into
OpenHands:mainfrom
KirschBluteX:docs/background-delegation-2047

Conversation

@KirschBluteX

@KirschBluteX KirschBluteX commented Aug 15, 2026

Copy link
Copy Markdown
  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes

  • Document the TaskToolSet background lifecycle added by OpenHands/software-agent-sdk#4503.
  • Show the blocking default and explicit run_in_background=True opt-in.
  • Document task_output, task_stop, task states, cooperative cancellation, bounded close behavior, and exactly-once metrics settlement.
  • Clarify that task IDs are process-local and are not restored after a process restart; active resume is rejected.

Validation

  • git diff --check passed.
  • The documented imports and lifecycle match the SDK implementation and its 165 focused/related tests.
  • Full-checkout Mint and desktop/mobile render checks were run previously. The final sparse checkout reports baseline missing-file/navigation warnings for files outside this PR; those files are unchanged here.

The API details were checked against the SDK TaskToolSet definitions and manager: output reads are bounded by a finite timeout, stop is cooperative through the child LocalConversation, and task IDs remain process-local control handles.

Co-authored-by: openhands <openhands@all-hands.dev>
KirschBluteX and others added 2 commits August 15, 2026 10:46
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant