Skip to content
This repository was archived by the owner on Jun 3, 2026. It is now read-only.

feat(docs): add human in the loop#866

Closed
lizradway wants to merge 1 commit into
strands-agents:mainfrom
lizradway:hitl
Closed

feat(docs): add human in the loop#866
lizradway wants to merge 1 commit into
strands-agents:mainfrom
lizradway:hitl

Conversation

@lizradway

Copy link
Copy Markdown
Member

Description

Adds documentation for the HumanInTheLoop vended intervention handler introduced in strands-agents/sdk-typescript#1073.

The new page covers:

  • Three collection modes: interrupt/resume (default), ask: 'stdio' (CLI readline), and custom async callbacks
  • Configuration options: allowedTools (with wildcard/negation patterns), enableTrust, custom evaluators
  • Cloud/API server example with session management
  • Comparison table vs raw interrupts

Also updates the sidebar navigation to group interventions as a labeled section, and adds a cross-reference from the interventions page to the new HITL page.

Related Issues

Type of Change

  • New content
  • Content update/revision
  • Structure/organization improvement
  • Typo/formatting fix
  • Bug fix
  • Other (please describe):

Checklist

  • I have read the CONTRIBUTING document
  • My changes follow the project's documentation style
  • I have tested the documentation locally using npm run dev
  • Links in the documentation are valid and working

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Comment thread site/src/content/docs/user-guide/concepts/agents/human-in-the-loop.ts Outdated
Comment thread site/src/content/docs/user-guide/concepts/agents/human-in-the-loop.mdx Outdated
Comment thread site/src/content/docs/user-guide/concepts/agents/human-in-the-loop.ts Outdated
@github-actions

Copy link
Copy Markdown
Contributor

Assessment: Request Changes

Good documentation page covering the HumanInTheLoop intervention handler. The structure is clear, the mermaid diagram is helpful, and the progression from basic to advanced usage is well-organized. Two substantive issues need addressing before merge.

Review Categories
  • Snippet completeness: Most code blocks are missing their import includes, breaking the MDX authoring pattern where each rendered block should be copy-pasteable with imports + body in one fence. Several snippets also reference undeclared variables (deleteFiles, readFile, transferFunds) that won't make sense to readers in isolation.
  • Frontmatter: Missing languages: [typescript] field that would auto-render the TypeScript-only banner consistently with the sibling interventions.mdx page.
  • Formatting: Line length violations (>90 chars) throughout the MDX prose and em-dash usage (banned per voice guide, though this is a pre-existing pattern in the repo).

The content and structure are solid. Fixing the snippet imports and undeclared variables will make the examples actually runnable for readers.

@github-actions

Copy link
Copy Markdown
Contributor

Documentation Preview Ready

Your documentation preview has been successfully deployed!

Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-cms-866/docs/user-guide/quickstart/overview/

Updated at: 2026-05-29T22:36:55.483Z

@lizradway

Copy link
Copy Markdown
Member Author

Closing to reopen in monorepo

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant