Skip to content

docs: review and update ADK-TS Events documentation #706

Closed
Demiladepy wants to merge 1 commit into
IQAIcom:mainfrom
Demiladepy:docs/issue-702-events-docs
Closed

docs: review and update ADK-TS Events documentation #706
Demiladepy wants to merge 1 commit into
IQAIcom:mainfrom
Demiladepy:docs/issue-702-events-docs

Conversation

@Demiladepy
Copy link
Copy Markdown

Summary

  • Reviewed the Events documentation section against the current @iqai/adk source
  • Updated Event/EventActions API references, runAsync examples, and streaming utilities
  • Documented compaction and rewind action types that were missing from event-actions.mdx

Fixes #702

Test plan

  • pnpm install in monorepo root
  • pnpm build in apps/docs
  • Preview updated pages locally with cd apps/docs && pnpm dev

Align Events docs with the current framework API, including accurate
Event/EventActions fields, runAsync usage, streaming utilities, and
compaction/rewind action types.

Fixes IQAIcom#702

Co-authored-by: Cursor <cursoragent@cursor.com>
@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented May 23, 2026

@Demiladepy is attempting to deploy a commit to the IQ Team on Vercel.

A member of the Team first needs to authorize it.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 23, 2026

⚠️ No Changeset found

Latest commit: ad32a39

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

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request significantly updates the documentation for the ADK-TS event system to align with recent framework changes. Key updates include the introduction of event compaction and rewind actions, a revised Event structure extending LlmResponse, and the standardization of the runner.runAsync method signature across all examples. Additionally, the documentation now features improved guidance on streaming utilities, event flow diagrams, and the logic for determining final responses. I have no feedback to provide as there were no review comments to assess.

@Demiladepy Demiladepy changed the title docs: review and update ADK-TS Events documentation docs: review and update ADK-TS Events documentation #702 May 23, 2026
@Demiladepy Demiladepy changed the title docs: review and update ADK-TS Events documentation #702 docs: review and update ADK-TS Events documentation May 23, 2026
@Timonwa Timonwa closed this May 29, 2026
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.

Review and update the ADK-TS Events documentation

2 participants