Skip to content

docs: inline streaming event types in guide (follows #205) #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

vrtnis
Copy link
Contributor

@vrtnis vrtnis commented Jul 17, 2025

This PR updates the Streaming guide to include inline documentation for the three event types emitted during streaming:

raw_model_stream_event

run_item_stream_event

agent_updated_stream_event

This aims to bring the JS SDK streaming docs in line with the Python SDK, which includes event references on the same page. It also fully resolves the request from #202, and complements the behavior fix in #205.

Screenshot shows output via pnpm docs:dev

Resolves #217

screenshot14-03-45

Copy link

changeset-bot bot commented Jul 17, 2025

⚠️ No Changeset found

Latest commit: a81dfa8

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

@seratch seratch added the documentation Improvements or additions to documentation label Jul 18, 2025
@seratch
Copy link
Member

seratch commented Jul 18, 2025

This is good addition! Another thing we may want to consider is to enrich the code comments to make the API reference document and have the links to them instead. It's be more accurate and up-to-date in the long run. That said, I don't oppose to have this change for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Streaming Events documentation (follow-up to #205)
3 participants