Skip to content

docs: present Pipecat Flows as built into core Pipecat - #964

Merged
kompfner merged 2 commits into
mainfrom
docs/flows-built-in-framing
Jun 29, 2026
Merged

docs: present Pipecat Flows as built into core Pipecat#964
kompfner merged 2 commits into
mainfrom
docs/flows-built-in-framing

Conversation

@kompfner

@kompfner kompfner commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

What & why

Pipecat Flows recently moved from its standalone package/repo into core Pipecat (pipecat-ai/pipecat#4882). Several docs pages still framed Flows as an external add-on you install separately. This PR reframes Flows as built in — it ships with pipecat-ai, imports from pipecat.flows, and lives in the main repo.

Changes

  • Install — drop the separate uv add pipecat-ai-flows; show only the pipecat-ai install with the note that Flows is included with Pipecat.
  • Importsfrom pipecat_flows import …from pipecat.flows import … across guides and API reference.
  • Links — repoint repo and example links from the standalone pipecat-ai/pipecat-flows repo to pipecat-ai/pipecat (examples now under examples/flows/).
  • API reference — point the Flows reference card at reference-server.pipecat.ai/en/latest/api/pipecat.flows.html (same build as base Pipecat) instead of the old reference-flows.pipecat.ai.
  • Wording — replace "add-on framework" with built-in framing, and rewrite the "How Pipecat and Pipecat Flows Work Together" section to describe Flows as a layer that builds on the pipeline (vs. a separate companion).
  • Migration guide — add a note that, as of pipecat-ai 1.5.0, Flows is part of core Pipecat and imports from pipecat.flows; update its examples to the new path. Kept as historical 0.0.x→1.0 content.

Kept as-is (by decision)

  • "Pipecat Flows" stays a top-level docs tab — using Flows materially changes how you design an app.
  • The /pipecat-flows/ URL namespace and redirects are unchanged.

🤖 Generated with Claude Code

Pipecat Flows moved from its standalone package/repo into core Pipecat
(pipecat-ai/pipecat#4882). Update the docs so Flows reads as built in
rather than a separate add-on:

- Drop the separate `uv add pipecat-ai-flows` install; Flows ships with
  pipecat-ai
- Update imports from `pipecat_flows` to `pipecat.flows`
- Repoint repo and example links to pipecat-ai/pipecat (examples/flows/)
- Point the Flows API reference card at reference-server.pipecat.ai
- Reword "add-on framework" and the Pipecat/Flows relationship section
  to describe Flows as a layer built on the pipeline
- Add a namespace note to the 1.0 migration guide
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Mintlify preview for this branch: https://daily-docs-flows-built-in-framing.mintlify.app

@kompfner
kompfner requested a review from markbackman June 29, 2026 18:41

@filipi87 filipi87 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.

LGTM! 🚀

@kompfner
kompfner merged commit 3c3120d into main Jun 29, 2026
3 checks passed

@markbackman markbackman 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.

Nice! Looks good.

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