docs: update for pipecat PR #4716#896
Open
markbackman wants to merge 1 commit into
Open
Conversation
- Add deprecation warning to WebsocketServerTransport configuration section - Update single-client limitation note to reference deprecation - Add deprecation note to transport params table - Recommend FastAPIWebsocketTransport as replacement
markbackman
added
auto-docs
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for 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
1 participant
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.
Automated documentation update for pipecat PR #4716.
Changes
Updated reference pages
api-reference/server/services/transport/websocket-server.mdx
api-reference/server/services/transport/transport-params.mdx
Summary
WebsocketServerTransport has been deprecated in pipecat 1.4.0 because it was intended for development and testing only and has a critical limitation: it only supports a single client at a time. The documentation now clearly warns users about this deprecation and directs them to use FastAPIWebsocketTransport instead for production use.
Gaps identified
None