Skip to content

docs: close gaps found in Kapa source analytics audit - #951

Merged
markbackman merged 3 commits into
mainfrom
docs/source-analytics-user-turn-strategies
Jun 26, 2026
Merged

docs: close gaps found in Kapa source analytics audit#951
markbackman merged 3 commits into
mainfrom
docs/source-analytics-user-turn-strategies

Conversation

@jamsea

@jamsea jamsea commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

What

Audited the top 10 most-cited docs.pipecat.ai pages 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 the pipecat source 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

Page Cites Change
stt/deepgram 182 Fix broken Flux import path (...flux to ...flux.stt) that threw an ImportError in copy-pasted examples
user-turn-strategies 438 Add custom max-turn stop-strategy example, turn-timing timeline, vad_analyzer param, 1.x migration note
speech-input 326 Explain why VAD is configured on the aggregator; cross-link noise-reduction filters
function-calling 216 Document run_in_parallel / group_parallel_tools for duplicate responses with parallel tool calls
context-management 181 Silent add (run_llm=False), LLMMessagesTransformFrame, TTSSpeakFrame(append_to_context=True) link
text-to-speech 179 State the append_to_context default (True, as of v1.4.0); resolves contradictory answers
choosing-a-transport 175 Clarify LiveKit is server-side only (no client transport); add telephony WebSocket use case
migration-1.0 168 Warn that removed params are silently ignored; add a concrete interruptions mapping
smart-turn-overview 168 Disambiguate the two stop_secs values (VAD 0.2 vs SmartTurnParams 3.0)
pipeline-termination 158 Frame-terminology table, complete the end-call example (result_callback + registration), on_pipeline_finished cleanup, max call duration, dangling-tasks troubleshooting

Notes

  • Source-verified against ../pipecat for every API name, import path, default value, and deprecation.
  • One known-stale value was left out of scope: smart-turn-overview lists pre_speech_ms default as 0.0 but source says 500. Flagging for a separate fix.
  • Formatted with Prettier. Internal links confirmed to resolve.

🤖 Generated with Claude Code

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
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Mintlify preview for this branch: https://daily-docs-source-analytics-user-turn-strategies.mintlify.app

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread pipecat/learn/context-management.mdx Outdated
Comment thread pipecat/learn/pipeline-termination.mdx

### 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).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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>
@markbackman
markbackman merged commit 7539492 into main Jun 26, 2026
3 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.

3 participants