Skip to content

docs: add YAML example to PromptBuilder documentation#11144

Merged
anakin87 merged 1 commit intodeepset-ai:mainfrom
ritikraj2425:docs/add-promptbuilder-yaml
Apr 20, 2026
Merged

docs: add YAML example to PromptBuilder documentation#11144
anakin87 merged 1 commit intodeepset-ai:mainfrom
ritikraj2425:docs/add-promptbuilder-yaml

Conversation

@ritikraj2425
Copy link
Copy Markdown
Contributor

Related Issues

Proposed Changes:

  • Added a YAML representation of the RAG pipeline to the PromptBuilder documentation.
  • Included an introductory sentence explaining how the pipeline renders a custom prompt template using retrieved documents and sends it to a generator.
  • Used the #### In YAML heading level to ensure the documentation hierarchy remains consistent with the other "In a pipeline" subsections.

How did you test it?

  • Manual verification: Confirmed the YAML connection mapping (prompt_builder.prompt -> llm.prompt) matches the Python pipeline logic.
  • Structure check: Verified that the new heading level (####) correctly nests the YAML example as a subsection within the "In a pipeline" category.

Notes for the reviewer

The indentation and structure of the YAML were cross-referenced with other recently updated components to ensure a uniform look and feel across the documentation.

Checklist

@ritikraj2425 ritikraj2425 requested a review from a team as a code owner April 19, 2026 11:24
@ritikraj2425 ritikraj2425 requested review from davidsbatista and removed request for a team April 19, 2026 11:24
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 19, 2026

@ritikraj2425 is attempting to deploy a commit to the deepset Team on Vercel.

A member of the Team first needs to authorize it.

@julian-risch
Copy link
Copy Markdown
Member

@davidsbatista There is a second PR currently under review that adds a YAML example for OpenAIGenerator where @anakin87 already requested some changes. #11145
I suggest we use the exact same YAML here too once the other PR is approved and delete the release note file. Then the PR should be ready to be merged.

@anakin87
Copy link
Copy Markdown
Member

I see that @davidsbatista already has many PRs to review, so I can take care of this one

@anakin87 anakin87 requested review from anakin87 and removed request for davidsbatista April 20, 2026 07:29
Comment thread releasenotes/notes/add-yaml-promptbuilder-docs-5a570b3010d0e1bf.yaml Outdated
Comment thread docs-website/docs/pipeline-components/builders/promptbuilder.mdx Outdated
@ritikraj2425 ritikraj2425 force-pushed the docs/add-promptbuilder-yaml branch from a689019 to dc25836 Compare April 20, 2026 07:43
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 20, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Apr 20, 2026 9:14am

Request Review

@ritikraj2425
Copy link
Copy Markdown
Contributor Author

Hey @anakin87,
All the comments are resolved!

Comment thread docs-website/docs/pipeline-components/builders/promptbuilder.mdx Outdated
@ritikraj2425 ritikraj2425 force-pushed the docs/add-promptbuilder-yaml branch from dc25836 to 1a30641 Compare April 20, 2026 09:10
@ritikraj2425 ritikraj2425 force-pushed the docs/add-promptbuilder-yaml branch from 1a30641 to 5821c51 Compare April 20, 2026 09:12
@ritikraj2425
Copy link
Copy Markdown
Contributor Author

@anakin87 resolved!

@anakin87 anakin87 merged commit fd63f53 into deepset-ai:main Apr 20, 2026
20 checks passed
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.

Add pipeline YAML example to Haystack documentation page of PromptBuilder

3 participants