Docs improvements from Kapa top questions analysis#983
Merged
Conversation
- Add 'Is Pipecat free?' notes to intro pages and a pricing link to the Pipecat Cloud intro (top question cluster: pricing and costs) - Add new Interruptions fundamentals page explaining barge-in mechanics, verified against the Pipecat source (cluster: interruptions and turn-taking) - Fix quickstart walkthrough snippets that drifted from the actual 'pipecat init quickstart' scaffold: OpenAIResponsesLLMService, RTVI on_client_ready greeting handler, runner.add_workers + run()
Contributor
|
🔍 Mintlify preview for this branch: https://daily-jh-top-questions-docs-improvements.mintlify.site |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Pipecat documentation to address common user questions (from Kapa analytics) by clarifying pricing/licensing, consolidating interruption mechanics, and bringing the Quickstart walkthrough back in sync with the current CLI scaffold.
Changes:
- Clarifies “Is Pipecat free?” in key intro pages (BSD-2; costs come from third-party AI services and hosting).
- Adds a new “Interruptions” fundamentals page explaining barge-in behavior, context effects, and configuration/triggering options.
- Updates the Quickstart “Understanding the Quickstart Bot” section to reflect current generated code patterns (OpenAI Responses LLM service, RTVI readiness kickoff, WorkerRunner usage).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
pipecat/get-started/quickstart.mdx |
Updates the walkthrough code snippets and narrative to match the current quickstart scaffold (LLM service, RTVI event, runner pattern). |
pipecat/get-started/introduction.mdx |
Adds a clear “Is Pipecat free?” note with licensing and cost sources. |
pipecat/fundamentals/interruptions.mdx |
Introduces a dedicated interruptions/barge-in page with mechanics, context behavior, and control/trigger guidance. |
pipecat-cloud/introduction.mdx |
Adds a usage-based pricing sentence with a link to current rates/calculator. |
overview/introduction.mdx |
Adds a top-level “Is Pipecat free?” note to reduce pricing confusion early in the docs. |
docs.json |
Registers the new interruptions fundamentals page in the docs navigation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…ection Replace the "Is Pipecat free?" Note callouts on the ecosystem and framework intro pages with a sentence in the opening paragraph: free under BSD-2, bring any provider, pay only for the services you choose. On the Pipecat Cloud intro, move the usage-based pricing paragraph out of the page opening into a dedicated Pricing section before Next Steps. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
markbackman
approved these changes
Jul 16, 2026
markbackman
left a comment
markbackman
left a comment
Contributor
There was a problem hiding this comment.
Just pushed a few changes, but looks great. Thank you!
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.
Summary
Improvements driven by the top 3 question clusters from our Kapa analytics export (275 combined threads).
1. Pricing and costs (102 threads)
The docs said "open source" but never directly answered "Is Pipecat free?", the most common phrasing users ask.
overview/introduction.mdxandpipecat/get-started/introduction.mdx: free, BSD-2 license, costs come from third-party AI services and hosting.pipecat-cloud/introduction.mdx.2. Interruptions and turn-taking (95 threads)
Turn detection was well documented, but interruption mechanics were scattered across frame reference entries.
pipecat/fundamentals/interruptions.mdx, registered indocs.json.broadcast_interruption()/InterruptionWorkerFrame.3. Getting started (78 threads)
The quickstart's "Understanding the Quickstart Bot" walkthrough had drifted from what
pipecat init quickstartactually generates. Verified against the CLI scaffold templates and fixed:OpenAIRealtimeLLMService→OpenAIResponsesLLMServicewith the real system instructionon_client_readyhandler with the dict form ofcontext.add_messagerunner.run(worker)→runner.add_workers(worker)+runner.run()🤖 Generated with Claude Code