docs: close gaps found in Kapa source analytics audit - #951
Conversation
Audited the top 10 most-cited docs.pipecat.ai pages against the user questions that cited them, and fixed the gaps that made Kapa give weak, stale, or contradictory answers. Each change was verified against the pipecat source. - stt/deepgram: fix broken Flux import path (was an ImportError) - user-turn-strategies: add custom max-turn stop strategy, turn-timing timeline, vad_analyzer param, and 1.x migration note - speech-input: explain why VAD is on the aggregator, link noise filters - function-calling: document run_in_parallel / group_parallel_tools for duplicate responses with parallel tool calls - context-management: silent add (run_llm=False), LLMMessagesTransformFrame, TTSSpeakFrame append_to_context link - text-to-speech: state append_to_context default (True, v1.4.0) - choosing-a-transport: LiveKit is server-only, telephony WebSocket use case - migration-1.0: warn that removed params are silently ignored, add a concrete interruptions mapping - smart-turn-overview: disambiguate the two stop_secs values - pipeline-termination: frame table, complete the end-call example, on_pipeline_finished cleanup, max call duration, dangling-tasks entry
|
🔍 Mintlify preview for this branch: https://daily-docs-source-analytics-user-turn-strategies.mintlify.app |
There was a problem hiding this comment.
Pull request overview
This PR updates several high-traffic Pipecat documentation pages to close gaps found in a Kapa source analytics audit, aiming to reduce stale/contradictory answers by making the docs the primary source of truth for commonly-cited user questions.
Changes:
- Fix and clarify API usage in multiple guides (e.g., Deepgram Flux import path, migration notes, function-calling parallel tool-call behavior).
- Add explanatory notes and practical examples for turn detection, context management, speech input/VAD configuration, and pipeline termination patterns.
- Improve transport selection guidance (including LiveKit positioning and telephony WebSocket use cases).
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
pipecat/migration/migration-1.0.mdx |
Adds migration warnings and updates turn-strategy examples/mapping for 0.0.x → 1.x. |
pipecat/learn/text-to-speech.mdx |
Clarifies TTSSpeakFrame.append_to_context behavior and documents the default as of v1.4.0. |
pipecat/learn/speech-input.mdx |
Explains why VAD config lives on the aggregator and adds noise-reduction cross-links. |
pipecat/learn/pipeline-termination.mdx |
Adds termination-frame terminology, completes end-call handler example, and documents shutdown patterns/troubleshooting. |
pipecat/learn/function-calling.mdx |
Documents run_in_parallel / group_parallel_tools behavior for multi-tool calls and duplicate responses. |
pipecat/learn/context-management.mdx |
Adds LLMMessagesTransformFrame and describes “silent” context edits via run_llm. |
client/concepts/choosing-a-transport.mdx |
Clarifies client/server transport pairing, LiveKit constraints, and telephony WebSocket positioning. |
api-reference/server/utilities/turn-management/user-turn-strategies.mdx |
Adds 1.x migration note, turn-timing timeline, vad_analyzer param docs, and a custom stop-strategy example. |
api-reference/server/utilities/turn-detection/smart-turn-overview.mdx |
Disambiguates VAD stop_secs vs SmartTurnParams.stop_secs. |
api-reference/server/services/stt/deepgram.mdx |
Fixes the Deepgram Flux STT import path (...flux.stt). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### What about LiveKit? | ||
|
|
||
| Pipecat ships a [LiveKit transport for the **server**](/api-reference/server/services/transport/livekit), so your bot can join a LiveKit room. There is **no** official Pipecat **client** transport for LiveKit (JS/React, React Native, or otherwise). |
There was a problem hiding this comment.
@markbackman this is a direct response to people asking the AI chatbots about Livekit. We do have an open PR here to make a transport: pipecat-ai/pipecat-client-web-transports#86
Might be worth merging in the PR and deleting this. But not sure how much of a lift that is for engineering. While we do get people asking the AI chatbot we don't have anyone on paid support asking about this so it might be lower in priority.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
6c3096f to
382f899
Compare
382f899 to
ab585ba
Compare
ab585ba to
4ab8f17
Compare
4ab8f17 to
84b6aeb
Compare
What
Audited the top 10 most-cited
docs.pipecat.aipages from a Kapa source analytics export against the actual user questions that cited each page, then fixed the gaps that made Kapa give weak, stale, or contradictory answers. Every change was verified against thepipecatsource before writing.Why
Kapa cites a page each time it answers a user question. Where a highly-cited page was missing a detail, Kapa had to reconstruct answers from GitHub source or Discord (or contradicted itself), which is a signal the docs page should own that answer.
Changes by page
stt/deepgram...fluxto...flux.stt) that threw anImportErrorin copy-pasted examplesuser-turn-strategiesvad_analyzerparam, 1.x migration notespeech-inputfunction-callingrun_in_parallel/group_parallel_toolsfor duplicate responses with parallel tool callscontext-managementrun_llm=False),LLMMessagesTransformFrame,TTSSpeakFrame(append_to_context=True)linktext-to-speechappend_to_contextdefault (True, as of v1.4.0); resolves contradictory answerschoosing-a-transportmigration-1.0smart-turn-overviewstop_secsvalues (VAD 0.2 vs SmartTurnParams 3.0)pipeline-terminationresult_callback+ registration),on_pipeline_finishedcleanup, max call duration, dangling-tasks troubleshootingNotes
../pipecatfor every API name, import path, default value, and deprecation.smart-turn-overviewlistspre_speech_msdefault as0.0but source says500. Flagging for a separate fix.🤖 Generated with Claude Code