Skip to content

added resumable streaming with minimal setup#26705

Merged
threepointone merged 2 commits into
productionfrom
sync-docs-pr-673
Nov 27, 2025
Merged

added resumable streaming with minimal setup#26705
threepointone merged 2 commits into
productionfrom
sync-docs-pr-673

Conversation

@agents-git-bot

@agents-git-bot agents-git-bot Bot commented Nov 23, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

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

@agents-git-bot
agents-git-bot Bot requested a review from a team November 23, 2025 20:53
@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

github-actions Bot commented Nov 23, 2025

Copy link
Copy Markdown
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

agents-git-bot Bot commented Nov 23, 2025

Copy link
Copy Markdown
Contributor 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

github-actions Bot commented Nov 25, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Preview URL: https://cb42c4d2.preview.developers.cloudflare.com
Preview Branch URL: https://sync-docs-pr-673.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/agents/api-reference/agents-api/ https://sync-docs-pr-673.preview.developers.cloudflare.com/agents/api-reference/agents-api/

@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

agents-git-bot Bot commented Nov 25, 2025

Copy link
Copy Markdown
Contributor 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.

@github-actions @claude
Add resumable streaming documentation
ac6ab72 
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 <noreply@anthropic.com>
@threepointone
threepointone merged commit 0890c58 into production Nov 27, 2025
9 checks passed
@threepointone
threepointone deleted the sync-docs-pr-673 branch November 27, 2025 19:59
@workers-devprod workers-devprod added the contribution [Holopin] Recognizes a docs contribution, big or small label Nov 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@threepointone threepointone threepointone approved these changes
@irvinebroque irvinebroque Awaiting requested review from irvinebroque irvinebroque is a code owner
@rita3ko rita3ko Awaiting requested review from rita3ko rita3ko is a code owner
@elithrar elithrar Awaiting requested review from elithrar elithrar is a code owner
@thomasgauvin thomasgauvin Awaiting requested review from thomasgauvin thomasgauvin is a code owner

Assignees

@elithrar elithrar

@threepointone threepointone

@irvinebroque irvinebroque

@rita3ko rita3ko

@thomasgauvin thomasgauvin

Labels

contribution [Holopin] Recognizes a docs contribution, big or small product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. size/l

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@threepointone @elithrar @irvinebroque @rita3ko @thomasgauvin @workers-devprod @whoiskatrin