docs: update for pipecat-flows PR #290#981
Closed
markbackman wants to merge 1 commit into
Closed
Conversation
Updates the migration guide to clearly document that the standalone pipecat-ai-flows package is deprecated and frozen as of pipecat-ai 1.5.0. Adds migration steps: - Upgrade to pipecat-ai >= 1.5.0 - Uninstall pipecat-ai-flows - Update imports from pipecat_flows to pipecat.flows Related to pipecat-ai/pipecat-flows#290
markbackman
added
auto-docs
Contributor
|
🔍 Mintlify preview for this branch: https://daily-docs-flows-pr-290.mintlify.app |
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-flows PR #290.
Changes
pipecat-flows/migration/migration-1.0.mdx— Expanded the migration note to explicitly document that the standalonepipecat-ai-flowspackage is deprecated and frozen as ofpipecat-ai1.5.0. Added step-by-step migration instructions: upgrade pipecat-ai, uninstall pipecat-ai-flows, and update imports frompipecat_flowstopipecat.flows. Includes before/after import examples.Context
PR #290 officially marks the standalone
pipecat-ai-flowspackage as deprecated and frozen. The package now emits aDeprecationWarningon import and pins its pipecat-ai dependency to<1.5.0to prevent conflicts with the integrated version.The docs already used the correct
pipecat.flowsimport path throughout (introduction, quickstart, guides, API reference). This update strengthens the migration guide with explicit deprecation notice and uninstall instructions.Gaps identified
None — all other doc pages already reflect that Flows is part of Pipecat as of 1.5.0.