Skip to content

Conversation

@agents-git-bot
Copy link

@agents-git-bot agents-git-bot bot commented Nov 23, 2025

Summary

This PR syncs documentation for the resumable streaming feature added to the Agents SDK.

Changes:

  • Added new guide: Resumable Streaming
  • Documents automatic resumable streaming in AIChatAgent
  • Includes server and client examples
  • Explains the underlying mechanism and how to disable if needed

Source

Test plan

  • Documentation builds successfully
  • All links are valid
  • Code examples follow Cloudflare style guide
  • TypeScriptExample and WranglerConfig components used correctly

🤖 Generated with Claude Code

@github-actions github-actions bot added product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. size/l labels Nov 23, 2025
@github-actions
Copy link
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/agents/ @irvinebroque, @rita3ko, @elithrar, @thomasgauvin, @threepointone, @cloudflare/pcx-technical-writing

@agents-git-bot agents-git-bot bot changed the title Add resumable streaming documentation added resumable streaming with minimal setup Nov 23, 2025
@agents-git-bot
Copy link
Author

Update: Fixed incorrect method name

I've just pushed a correction to fix an inaccuracy in the documentation. The method name was incorrectly documented as _rsm_generateResponse() throughout, but the actual implementation in the source code uses _handleStreamGeneration().

Changes made:

  • ✅ Updated method name in "Required implementation" section
  • ✅ Fixed ResumableStreamAgent interface definition
  • ✅ Corrected message flow description
  • ✅ Updated complete example code

The documentation now accurately reflects the actual API as implemented in the resumable-stream-chat example.

@agents-git-bot agents-git-bot bot force-pushed the sync-docs-pr-673 branch 2 times, most recently from 2658066 to 9e3aa5d Compare November 25, 2025 09:45
@github-actions
Copy link
Contributor

github-actions bot commented Nov 25, 2025

@agents-git-bot agents-git-bot bot force-pushed the sync-docs-pr-673 branch 2 times, most recently from d768980 to d8bd0d4 Compare November 25, 2025 13:39
@agents-git-bot
Copy link
Author

Documentation update complete

Added comprehensive API reference documentation at /agents/api-reference/resumable-streaming.mdx to complement the existing how-to guide.

What's new:

  • Technical API reference page with detailed implementation examples
  • Clear separation between reference documentation (API details) and tutorial content (how-to guide)
  • Following the Diátaxis framework for documentation structure

The PR now includes both:

  1. API Reference (/api-reference/resumable-streaming/) - Technical docs for developers looking up the API
  2. How-to Guide (/guides/resumable-streaming/) - Step-by-step tutorial for implementing the feature

Both pages follow Cloudflare docs style guide requirements and use proper MDX components.

Synced from cloudflare/agents PR #673: added resumable streaming with minimal setup

This documentation covers the automatic resumable streaming feature in AIChatAgent that allows chat streams to seamlessly resume after disconnections.

Source PR: cloudflare/agents#673

🤖 Generated with Claude Code

Co-Authored-By: Claude <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. size/l

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants