Skip to content

docs: clarify SystemFrame queue behavior#804

Merged
markbackman merged 1 commit into
mainfrom
mb/fix-system-frame-queue-docs
May 7, 2026
Merged

docs: clarify SystemFrame queue behavior#804
markbackman merged 1 commit into
mainfrom
mb/fix-system-frame-queue-docs

Conversation

@markbackman
Copy link
Copy Markdown
Contributor

@markbackman markbackman commented May 7, 2026

Summary

Updates the docs to clarify current SystemFrame queue behavior.

SystemFrames no longer bypass queues. They use the high-priority input queue, remain ordered with other SystemFrames, and are not discarded by interruptions. DataFrames and ControlFrames continue to use the non-system process queue and are ordered with each other.

Also adds the missing broadcast_sibling_id property to the Frames overview.

Fixes pipecat-ai/pipecat#4445

Changes

  • Corrects stale “processed immediately” / “bypass queues” language in pipeline docs
  • Clarifies ordering guarantees by processing lane
  • Updates termination docs for CancelFrame priority behavior
  • Updates RTVI docs for RTVIServerMessageFrame propagation behavior
  • Documents broadcast_sibling_id in frame properties

Testing

  • Searched docs for stale phrases like SystemFrames bypass queues, bypassing queues, processed immediately, and propagates immediately
  • No docs build was run locally because the docs repo does not expose an obvious root build script

@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 7, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
daily 🟢 Ready View Preview May 7, 2026, 11:17 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@markbackman markbackman merged commit 18cec19 into main May 7, 2026
2 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.

[Docs] System Frames Are Still Queued, but Docs Seem To Indicate They're Not

1 participant