Skip to content

docs: update for pipecat PR #5482 - #1187

Merged
markbackman merged 2 commits into
mainfrom
docs/pr-5482
Aug 28, 2026
Merged

docs: update for pipecat PR #5482#1187
markbackman merged 2 commits into
mainfrom
docs/pr-5482

Conversation

@pipecat-docs-bot

Copy link
Copy Markdown

Automated documentation update for pipecat PR #5482.

Changes

api-reference/server/utilities/runner/guide.mdx

  • Added new "Runner Lifecycle Management" section documenting runner.cancel() for ending sessions early
  • Updated handle_sigint parameter documentation to explain it should be passed from runner_args.handle_sigint
  • Added example showing runner must be created before event handlers that need to call runner.cancel()

pipecat/get-started/quickstart.mdx

  • Updated event handler example to use await runner.cancel() instead of await worker.cancel()
  • Updated runner initialization to use runner_args.handle_sigint instead of hardcoded False
  • Added note explaining runner must be created before event handlers

pipecat/learn/pipeline-termination.mdx

  • Updated all event handler examples to use await runner.cancel() instead of await worker.cancel()
  • Updated WorkerRunner initialization examples to use runner_args.handle_sigint pattern
  • Updated error handling example to use runner-level cancellation

Gaps identified

None. All relevant documentation pages have been updated to reflect the new pattern where:

  1. The WorkerRunner is created before event handlers are registered
  2. Event handlers call await runner.cancel() instead of await worker.cancel()
  3. The runner uses runner_args.handle_sigint in scaffolded bots

Note: Some pages (e.g., pipecat/learn/proxy-agents.mdx) correctly use handle_sigint=False in FastAPI websocket endpoint contexts where the server handles signals - these were not changed.

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
@pipecat-docs-bot pipecat-docs-bot Bot added auto-docs Automated documentation update from pipecat source changes pipecat labels Aug 28, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Mintlify preview for this branch: https://daily-docs-pr-5482.mintlify.site

@markbackman
markbackman merged commit 90b5b38 into main Aug 28, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-docs Automated documentation update from pipecat source changes pipecat

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant