Skip to content

docs: add TypeScript examples to interrupts documentation#778

Merged
zastrowm merged 4 commits intostrands-agents:mainfrom
zastrowm:typescript_interrupts
May 8, 2026
Merged

docs: add TypeScript examples to interrupts documentation#778
zastrowm merged 4 commits intostrands-agents:mainfrom
zastrowm:typescript_interrupts

Conversation

@zastrowm
Copy link
Copy Markdown
Member

@zastrowm zastrowm commented Apr 23, 2026

Description

Update docs for interrupts & TypeScript; will fail until interrupts merges

Preview: https://d3ehv1nix5p99z.cloudfront.net/pr-cms-778/docs/user-guide/concepts/interrupts/

Related Issues

strands-agents/sdk-typescript#784

Type of Change

  • Content update/revision

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.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 23, 2026

Documentation Preview Ready

Your documentation preview has been successfully deployed!

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

Updated at: 2026-04-27T16:35:02.628Z

Comment thread src/content/docs/user-guide/concepts/interrupts.ts Outdated
Comment thread src/content/docs/user-guide/concepts/interrupts.mdx
Comment thread src/content/docs/user-guide/concepts/interrupts.ts Outdated
@github-actions
Copy link
Copy Markdown
Contributor

Assessment: Comment

Good addition of TypeScript examples to the interrupts documentation. The tab structure, snippet markers, and code quality all look solid. One theme across the inline comments:

Review Details
  • Snippet boundaries: Two of the three snippets (hooks_example, session_management) reference tool variables (deleteFiles, inspectFiles) that are defined outside the snippet markers. When rendered, readers will see these used but never defined — unlike the tools_example snippet which correctly includes the definitions within its markers. This is the main item to address.
  • BeforeToolsEvent coverage: The prose mentions BeforeToolsEvent as interruptible but no code example or import demonstrates it — a small gap between text and code.

The overall structure and consistency with the Python examples is well done.

@github-actions
Copy link
Copy Markdown
Contributor

Documentation Preview Failed

The documentation deployment encountered an error. Please check the deployment logs for more details.

Comment thread src/content/docs/user-guide/concepts/interrupts.mdx
@github-actions
Copy link
Copy Markdown
Contributor

Assessment: Comment

The previous review feedback has been addressed well — snippet boundaries now include tool definitions and the BeforeToolsEvent example has been added. One remaining item:

Review Details
  • Warning visibility: The "direct tool calls" warning (⚠️) moved from a shared position into the Python tab only, making it invisible to TypeScript readers. If this limitation applies to both SDKs, it should be moved back outside the tabs.

Clean, well-structured PR that follows the repo's conventions for TypeScript doc examples.

@github-actions
Copy link
Copy Markdown
Contributor

Assessment: Approve

All three previously raised issues have been addressed and the author's clarification on the direct tool call warning makes sense (TS SDK doesn't have direct tool calls). No new issues found.

Verification Summary
  • Snippet boundaries: All 4 snippets (hooks_before_tool_call, hooks_before_tools, tools_example, session_management) now include tool definitions within their markers ✅
  • BeforeToolsEvent: Dedicated example added with BeforeToolsEvent import and batch approval pattern ✅
  • Tab balance: 12 <Tabs> / 12 </Tabs>, 24 <Tab> / 24 </Tab> — all matched ✅
  • Snippet refs match defs: 4/4 snippet names match between MDX and TS ✅
  • Line length: All snippet content within 90 chars (only line 2 comment at 107 chars, outside snippets) ✅
  • Code style: No semicolons, single quotes, trailing commas, markers inside functions ✅
  • Doc preview: Builds successfully ✅

@zastrowm zastrowm marked this pull request as ready for review April 27, 2026 16:31
@github-actions
Copy link
Copy Markdown
Contributor

Assessment: Approve

No changes since the last review pass. All 4 prior review threads are resolved and all automated checks still pass. This PR is ready to merge (pending the upstream interrupts feature merge noted in the description).

Checks confirmed
  • Snippet refs ↔ defs: 4/4 match ✅
  • Tab balance: 12/12 <Tabs>, 24/24 <Tab>
  • Snippet line length: all ≤90 chars ✅
  • Style: 0 semicolons ✅
  • Doc preview: builds successfully ✅

@github-actions
Copy link
Copy Markdown
Contributor

Assessment: Approve

No changes since the previous approval. All 4 review threads remain resolved, all structural checks pass, and the documentation preview builds successfully. Ready to merge once the upstream interrupts feature lands.

@zastrowm zastrowm merged commit 46546b3 into strands-agents:main May 8, 2026
8 checks passed
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.

3 participants