docs: update for pipecat-flows PR #277#857
Open
markbackman wants to merge 1 commit into
Open
Conversation
Update FlowManager documentation to reflect the migration from PipelineTask to PipelineWorker introduced in pipecat-flows PR #277. Changes: - Add `worker` parameter to FlowManager (replaces `task`) - Mark `task` parameter as deprecated - Add `worker` property documentation - Mark `task` property as deprecated with backward compatibility note - Update all code examples to use `worker` instead of `task` - Update WorkerRunner usage in quickstart (add_workers + run pattern) Files updated: - api-reference/pipecat-flows/flow-manager.mdx - pipecat-flows/guides/state-management.mdx - pipecat-flows/guides/quickstart.mdx
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-flows PR #277.
Changes
API Reference
workerparameter (required) to replace deprecatedtaskparametertaskparameterworkerproperty documentationtaskproperty with deprecation warning and backward compatibility noteworkerinstead oftaskGuides
pipecat-flows/guides/state-management.mdx
workerparametertasktoworkerfor claritypipecat-flows/guides/quickstart.mdx
tasktoworkerworkerparameterrunner.add_workers(worker)+runner.run()Gaps identified
None — all documentation changes align with the API migration in PR #277.