Skip to content

docs: add code for "recipes" #10021

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Nov 6, 2025
Merged

docs: add code for "recipes" #10021

merged 2 commits into from
Nov 6, 2025

Conversation

@dfokina
Copy link
Contributor

@dfokina dfokina commented Nov 5, 2025

Related Issues

  • It is not possible to recreate the same experience of "Recipes" as they existed in readme.com

Proposed Changes:

  • Instead of recipes, I am inserting code snippets with extended code comments
  • Update some recipes to use more suitable components
  • Replace the mermaid graph to correspond to an updated pipeline

How did you test it?

Ran code samples to make sure they work

Notes for the reviewer

Checklist

  • I have read the contributors guidelines and the code of conduct
  • I have updated the related issue with new insights and changes
  • I added unit tests and updated the docstrings
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I documented my code
  • I ran pre-commit hooks and fixed any issue

@dfokina dfokina requested a review from a team as a code owner November 5, 2025 16:11
@dfokina dfokina removed the request for review from a team November 5, 2025 16:11
@dfokina dfokina added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Nov 5, 2025
@dfokina dfokina requested a review from davidsbatista November 5, 2025 16:11
@vercel
Copy link

vercel bot commented Nov 5, 2025 •
edited
Loading

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

Project Deployment Preview Comments Updated (UTC)
haystack-docs Ready Ready Preview Comment Nov 5, 2025 4:14pm

davidsbatista
davidsbatista approved these changes Nov 6, 2025
View reviewed changes
Copy link
Contributor

@davidsbatista davidsbatista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@davidsbatista davidsbatista merged commit 89f4208 into main Nov 6, 2025
11 checks passed
@davidsbatista davidsbatista deleted the fix-recipes branch November 6, 2025 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@davidsbatista davidsbatista davidsbatista approved these changes

Assignees

No one assigned

Labels

ignore-for-release-notes PRs with this flag won't be included in the release notes.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dfokina @davidsbatista