Skip to content

docs: add FalkorDB integration documentation#11293

Open
julian-risch wants to merge 2 commits intomainfrom
docs/falkordb-integration
Open

docs: add FalkorDB integration documentation#11293
julian-risch wants to merge 2 commits intomainfrom
docs/falkordb-integration

Conversation

@julian-risch
Copy link
Copy Markdown
Member

@julian-risch julian-risch commented May 11, 2026

Related Issues

Proposed Changes:

  • Adds documentation page for FalkorDBDocumentStore at docs-website/docs/document-stores/falkordbdocumentstore.mdx
  • Adds documentation page for FalkorDBEmbeddingRetriever at docs-website/docs/pipeline-components/retrievers/falkordbembeddingretriever.mdx
  • Adds documentation page for FalkorDBCypherRetriever at docs-website/docs/pipeline-components/retrievers/falkordbcypherretriever.mdx
  • Updates sidebars.js to include the three new pages in the navigation (document stores and retrievers sections)
  • Apply same changes to 2.28 versioned docs

How did you test it?

All code examples in the documentation were tested against a live FalkorDB instance.

  • Tested FalkorDBDocumentStore basic write/count example
  • Tested FalkorDBEmbeddingRetriever standalone example (vector similarity search)
  • Tested FalkorDBEmbeddingRetriever in a pipeline with SentenceTransformersTextEmbedder
  • Tested FalkorDBCypherRetriever standalone example (OpenCypher query with parameters)
  • Tested FalkorDBCypherRetriever in a pipeline with ChatPromptBuilder + HuggingFaceLocalChatGenerator

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 have 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 have documented my code.
  • I have added a release note file, following the contributors guidelines.
  • I have run pre-commit hooks and fixed any issue.

🤖 Generated with Claude Code

Add documentation pages for FalkorDBDocumentStore, FalkorDBEmbeddingRetriever,
and FalkorDBCypherRetriever following the haystack-core-integrations PR #3158.
Update sidebars.js to include the new pages in the navigation.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 11, 2026

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

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment May 11, 2026 10:30am

Request Review

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@julian-risch julian-risch marked this pull request as ready for review May 11, 2026 10:30
@julian-risch julian-risch requested a review from a team as a code owner May 11, 2026 10:30
@julian-risch julian-risch requested review from sjrl and removed request for a team May 11, 2026 10:30
@julian-risch julian-risch enabled auto-merge (squash) May 11, 2026 10:30
@claude
Copy link
Copy Markdown

claude Bot commented May 11, 2026

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

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.

1 participant