docs: clarify run context, handoffs, and human-in-the-loop guides#1053
Merged
docs: clarify run context, handoffs, and human-in-the-loop guides#1053
Conversation
|
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
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.
This pull request updates five core guides under
docs/src/content/docs/guides/to make advanced run behavior easier to reason about. It clarifiesRunContextand serialization incontext.mdx, guardrail scope and workflow boundaries inguardrails.mdx, handoffinputTypeandinputFilterbehavior inhandoffs.mdx, approval/resume behavior for nestedagent.asTool()flows inhuman-in-the-loop.mdx, and result-surface selection inresults.mdx.The main goal is to remove ambiguity around nested runs, handoffs, approvals, and resumable state. In particular, the docs now spell out which guardrails run where, how handoff metadata differs from destination selection, how interruptions behave across nested agent-tool executions, and when to use
history,output,newItems,interruptions,state, and streamed-result fields.