Skip to content

docs(mastra): add interrupt-based HITL docs for suspend/resume support#3634

Merged
jpr5 merged 1 commit intomainfrom
docs/mastra-interrupt-support
Apr 13, 2026
Merged

docs(mastra): add interrupt-based HITL docs for suspend/resume support#3634
jpr5 merged 1 commit intomainfrom
docs/mastra-interrupt-support

Conversation

@mxmzb
Copy link
Copy Markdown
Contributor

@mxmzb mxmzb commented Apr 6, 2026

Summary

  • Restructures Mastra Human-in-the-Loop docs from a single page into a subfolder with two approaches
  • Adds new interrupt-flow.mdx documenting Mastra's native suspend()/resumeuseInterrupt flow (basic + advanced usage with enabled routing and handler preprocessing)
  • Extracts existing tool-based content into tool-based.mdx and removes the "suspend/resume not supported" warning
  • Adds index.mdx landing page with CTACards linking both approaches
  • Updates Mastra meta.json to add a "Mastra" nav section with the HITL pages

Companion docs for ag-ui-protocol/ag-ui#1359 and #3505.

Test plan

  • Verify docs build locally (nx run docs:build)
  • Verify navigation: Mastra sidebar shows "Interrupts" and "Tool-based" under "Mastra" section
  • Verify root HITL hub (/human-in-the-loop) still links to Mastra via IntegrationGrid
  • Verify cross-links between interrupt-flow and tool-based pages work
  • Verify CTACards on the index landing page link correctly

🤖 Generated with Claude Code

Restructures Mastra HITL from a single page into a subfolder with two
approaches: interrupt-based (new, using useInterrupt + Mastra's native
tool suspension) and tool-based (existing useHumanInTheLoop content).

Companion docs for ag-ui-protocol/ag-ui#1359 and #3505.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 6, 2026

⚠️ No Changeset found

Latest commit: ae101e0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented Apr 6, 2026

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

Project Deployment Actions Updated (UTC)
chat-with-your-data Ready Ready Preview, Comment Apr 6, 2026 11:56pm
docs Ready Ready Preview, Comment Apr 6, 2026 11:56pm
form-filling Ready Ready Preview, Comment Apr 6, 2026 11:56pm
research-canvas Ready Ready Preview, Comment Apr 6, 2026 11:56pm
travel Ready Ready Preview, Comment Apr 6, 2026 11:56pm

Request Review

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 6, 2026

📣 Social Copy Generator

Generate social media copies (Twitter/X, LinkedIn, Blog Post) for this PR using Claude.

  • Generate social media copies

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Apr 6, 2026

Open in StackBlitz

@copilotkit/a2ui-renderer

pnpm add https://pkg.pr.new/CopilotKit/CopilotKit/@copilotkit/a2ui-renderer@3634

@copilotkitnext/angular

pnpm add https://pkg.pr.new/CopilotKit/CopilotKit/@copilotkitnext/angular@3634

copilotkit

pnpm add https://pkg.pr.new/CopilotKit/CopilotKit/copilotkit@3634

@copilotkit/core

pnpm add https://pkg.pr.new/CopilotKit/CopilotKit/@copilotkit/core@3634

@copilotkit/react-core

pnpm add https://pkg.pr.new/CopilotKit/CopilotKit/@copilotkit/react-core@3634

@copilotkit/react-textarea

pnpm add https://pkg.pr.new/CopilotKit/CopilotKit/@copilotkit/react-textarea@3634

@copilotkit/react-ui

pnpm add https://pkg.pr.new/CopilotKit/CopilotKit/@copilotkit/react-ui@3634

@copilotkit/runtime

pnpm add https://pkg.pr.new/CopilotKit/CopilotKit/@copilotkit/runtime@3634

@copilotkit/runtime-client-gql

pnpm add https://pkg.pr.new/CopilotKit/CopilotKit/@copilotkit/runtime-client-gql@3634

@copilotkit/sdk-js

pnpm add https://pkg.pr.new/CopilotKit/CopilotKit/@copilotkit/sdk-js@3634

@copilotkit/shared

pnpm add https://pkg.pr.new/CopilotKit/CopilotKit/@copilotkit/shared@3634

@copilotkit/sqlite-runner

pnpm add https://pkg.pr.new/CopilotKit/CopilotKit/@copilotkit/sqlite-runner@3634

@copilotkit/voice

pnpm add https://pkg.pr.new/CopilotKit/CopilotKit/@copilotkit/voice@3634

@copilotkit/web-inspector

pnpm add https://pkg.pr.new/CopilotKit/CopilotKit/@copilotkit/web-inspector@3634

commit: ae101e0

Copy link
Copy Markdown
Contributor

@jpr5 jpr5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs-only PR, clean content. Restructures Mastra HITL docs from single page into interrupt-flow + tool-based approaches.

  • Code examples are accurate (useInterrupt, suspend/resume, enabled routing, handler preprocessing)
  • Removed stale "suspend/resume not supported" warning
  • Navigation structure is logical
  • Cross-links between approaches are correct

LGTM.

🤖 Reviewed with Claude Code

@jpr5 jpr5 merged commit 0ed497d into main Apr 13, 2026
13 checks passed
@jpr5 jpr5 deleted the docs/mastra-interrupt-support branch April 13, 2026 20:31
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.

2 participants