Skip to content

docs: correct syntax and phrasing in Qdrant documentation#10965

Open
Goodnight77 wants to merge 10 commits intodeepset-ai:mainfrom
Goodnight77:fix/qdrant-docs-cleanup
Open

docs: correct syntax and phrasing in Qdrant documentation#10965
Goodnight77 wants to merge 10 commits intodeepset-ai:mainfrom
Goodnight77:fix/qdrant-docs-cleanup

Conversation

@Goodnight77
Copy link
Copy Markdown

Proposed Changes:

this PR cleans up Qdrant-related documentation in the current docs
it fixes some typos and wording issues in the qdrant api reference and some of the user facing pages :

  • misspelling of qdrant-haystack
  • duplicated wording such as directly
  • fixed the sparse retriever example to import FastembedSparseDocumentEmbedder and FastembedSparseTextEmbedder
  • fixed HNSW spelling
  • corrected the sparse model name typo prithvida/... to prithivida/

How did you test it?

manual verification only (documentation fixes )

Notes for the reviewer

the changes are documentation-only and focused on some of Qdrant pages

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.

Copilot AI review requested due to automatic review settings March 27, 2026 19:28
@Goodnight77 Goodnight77 requested a review from a team as a code owner March 27, 2026 19:28
@Goodnight77 Goodnight77 requested review from davidsbatista and removed request for a team March 27, 2026 19:28
@vercel
Copy link
Copy Markdown

vercel bot commented Mar 27, 2026

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

A member of the Team first needs to authorize it.

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Mar 27, 2026

CLA assistant check
All committers have signed the CLA.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR cleans up Qdrant-related documentation by fixing typos, improving phrasing, and correcting code examples (notably around sparse embeddings and model names).

Changes:

  • Fix wording/grammar issues across Qdrant docs and API reference (articles, duplicated words, punctuation).
  • Correct sparse retriever examples to import and use the sparse Fastembed embedders and fix a sparse model name typo.
  • Fix terminology typos such as the HNSW spelling and qdrant-haystack package name.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs-website/versioned_docs/version-2.26/pipeline-components/retrievers/qdrantsparseembeddingretriever.mdx Fix sparse embedder imports and improve wording/casing.
docs-website/versioned_docs/version-2.26/pipeline-components/retrievers/qdranthybridretriever.mdx Fix output var name, wording, model name typo, and pipeline example variable.
docs-website/versioned_docs/version-2.26/pipeline-components/retrievers/qdrantembeddingretriever.mdx Fix HNSW spelling and improve sentence punctuation.
docs-website/versioned_docs/version-2.26/document-stores/qdrant-document-store.mdx Improve intro phrasing and remove duplicated “directly”; normalize wording.
docs-website/reference_versioned_docs/version-2.26/integrations-api/qdrant.md Fix grammar (“a QdrantDocumentStore”), host parameter text, and qdrant-haystack typo.
docs-website/reference/integrations-api/qdrant.md Same API reference grammar fixes for non-versioned docs.
docs-website/docs/pipeline-components/retrievers/qdrantsparseembeddingretriever.mdx Mirror sparse embedder import and wording fixes in unversioned docs.
docs-website/docs/pipeline-components/retrievers/qdranthybridretriever.mdx Mirror hybrid retriever wording/model fixes and pipeline example variable in unversioned docs.
docs-website/docs/pipeline-components/retrievers/qdrantembeddingretriever.mdx Mirror HNSW/punctuation fixes in unversioned docs.
docs-website/docs/document-stores/qdrant-document-store.mdx Mirror Qdrant doc-store wording fixes in unversioned docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…s-api/qdrant.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: David S. Batista <dsbatista@gmail.com>
Copy link
Copy Markdown
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.

@Goodnight77 thanks for the corrections!

I've reverted some changes, including references to types of components/components names"; they should be capitalised.

We also need to apply the same changes to the 2.26 docs.

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 30, 2026

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

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

Request Review

@davidsbatista davidsbatista added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Mar 30, 2026
| GitHub link | https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/qdrant |

</div>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Since we released 2.27 in the meantime, instead of changing docs-website/versioned_docs/version-2.26, could you please move these changes to docs-website/versioned_docs/version-2.27?

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

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants