docs: fix factual errors in transport docs and CLI init page#646
Merged
chadbailey59 merged 1 commit intomainfrom Mar 24, 2026
Merged
docs: fix factual errors in transport docs and CLI init page#646chadbailey59 merged 1 commit intomainfrom
chadbailey59 merged 1 commit intomainfrom
Conversation
- Fix wrong npm package name in Gemini transport footer (`@pipecat-ai/realtime-websocket-transport` → `@pipecat-ai/gemini-live-websocket-transport`) - Fix Gemini transport using `generation_config` instead of `settings` in both the code example and interface definition - Fix OpenAI WebRTC transport using `session_config` instead of `settings` in the code example - Fix SmallWebRTC `iceServers` type from `string[]` to `RTCIceServer[]` and update examples to use object format - Remove `--smart-turn / --no-smart-turn` flag from CLI init docs (removed from CLI in a prior release) and remove `smart_turn` from sample config JSON Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
markbackman
approved these changes
Mar 24, 2026
Contributor
markbackman
left a comment
markbackman
left a comment
There was a problem hiding this comment.
LGTM!
That's a pretty random assortment. Thanks for catching them.
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
2 participants
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.
I'm doing some docs cleanup, so expect a few more PRs from one of my Claudes :)
Summary
Fixes 5 factual errors found during a documentation audit against the source repositories:
@pipecat-ai/realtime-websocket-transport→@pipecat-ai/gemini-live-websocket-transport)generation_configinstead ofsettings(verified againstgeminiLiveWebSocketTransport.ts)session_configinstead ofsettings(verified againstOpenAIRealTimeWebRTCTransport.ts)iceServerstyped asstring[]but source type isRTCIceServer[]— updated type and all examples to use{ urls: "..." }object format--smart-turn / --no-smart-turnflag was removed from the CLI (per CHANGELOG) but still appeared in docs — removed ParamField and"smart_turn"from sample config JSONTest plan
🤖 Generated with Claude Code