Skip to content

docs: update for pipecat PR #5628 - #1278

Closed
pipecat-docs-bot[bot] wants to merge 2 commits into
mainfrom
docs/pr-5628
Closed

docs: update for pipecat PR #5628#1278
pipecat-docs-bot[bot] wants to merge 2 commits into
mainfrom
docs/pr-5628

Conversation

@pipecat-docs-bot

Copy link
Copy Markdown

Automated documentation update for pipecat PR #5628.

Changes

New Page

  • flow-config.mdx: Complete reference for FlowConfig and Flow classes, including YAML/JSON flow configuration, prompt placeholders ({{ key }}), branch transitions, and the !include directive

Updated Pages

  • flow-manager.mdx:

    • Added Prompt Placeholders section documenting {{ key }} template support in prompts
    • Updated state property documentation to reference placeholder usage
  • types.mdx:

    • Added TRANSITION_IN_YAML sentinel documentation for configured flows
    • Updated ConsolidatedFunctionResult type to include TRANSITION_IN_YAML
  • exceptions.mdx:

    • Added FlowReferenceError exception class for unresolved flow config references
    • Added FlowProblem dataclass documenting individual reference problems
    • Updated exception hierarchy to include FlowReferenceError
  • docs.json: Added flow-config page to Pipecat Flows navigation

Gaps identified

None - all source changes are fully documented.

- Add FlowConfig and Flow documentation (new page: flow-config.mdx)
- Document TRANSITION_IN_YAML sentinel for configured flows
- Add FlowReferenceError and FlowProblem exception classes
- Document {{ key }} placeholder support in prompts
- Update navigation to include new flow-config page

Co-authored-by: claude-code <[email protected]>
@pipecat-docs-bot pipecat-docs-bot Bot added auto-docs Automated documentation update from pipecat source changes pipecat labels Sep 10, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Mintlify preview for this branch: https://daily-docs-pr-5628.mintlify.site

@markbackman

Copy link
Copy Markdown
Contributor

Docs to be manually written.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-docs Automated documentation update from pipecat source changes pipecat

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant