docs: update for pipecat PR #5482 - #1187
Merged
Merged
Conversation
Update documentation to reflect changes from pipecat PR #5482: - Event handlers now use `await runner.cancel()` instead of `await worker.cancel()` - WorkerRunner is created before event handlers so handlers can call runner.cancel() - Runner uses `runner_args.handle_sigint` instead of hardcoded `False` in scaffolded bots Updated pages: - api-reference/server/utilities/runner/guide.mdx: Added Runner Lifecycle Management section with runner.cancel() documentation - pipecat/get-started/quickstart.mdx: Updated event handler pattern and added note about runner initialization order - pipecat/learn/pipeline-termination.mdx: Updated all examples to use runner.cancel() and runner_args.handle_sigint
Contributor
|
🔍 Mintlify preview for this branch: https://daily-docs-pr-5482.mintlify.site |
markbackman
force-pushed
the
docs/pr-5482
branch
from
August 28, 2026 15:53
509fe17 to
3f40069
Compare
markbackman
approved these changes
Aug 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Automated documentation update for pipecat PR #5482.
Changes
api-reference/server/utilities/runner/guide.mdx
runner.cancel()for ending sessions earlyhandle_sigintparameter documentation to explain it should be passed fromrunner_args.handle_sigintrunner.cancel()pipecat/get-started/quickstart.mdx
await runner.cancel()instead ofawait worker.cancel()runner_args.handle_sigintinstead of hardcodedFalsepipecat/learn/pipeline-termination.mdx
await runner.cancel()instead ofawait worker.cancel()runner_args.handle_sigintpatternGaps identified
None. All relevant documentation pages have been updated to reflect the new pattern where:
await runner.cancel()instead ofawait worker.cancel()runner_args.handle_sigintin scaffolded botsNote: Some pages (e.g.,
pipecat/learn/proxy-agents.mdx) correctly usehandle_sigint=Falsein FastAPI websocket endpoint contexts where the server handles signals - these were not changed.