docs: correct syntax and phrasing in Qdrant documentation#10965
docs: correct syntax and phrasing in Qdrant documentation#10965Goodnight77 wants to merge 10 commits intodeepset-ai:mainfrom
Conversation
|
@Goodnight77 is attempting to deploy a commit to the deepset Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
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-haystackpackage 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.
docs-website/reference_versioned_docs/version-2.26/integrations-api/qdrant.md
Show resolved
Hide resolved
docs-website/docs/pipeline-components/retrievers/qdranthybridretriever.mdx
Show resolved
Hide resolved
…s-api/qdrant.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
docs-website/docs/pipeline-components/retrievers/qdranthybridretriever.mdx
Outdated
Show resolved
Hide resolved
docs-website/docs/pipeline-components/retrievers/qdranthybridretriever.mdx
Outdated
Show resolved
Hide resolved
docs-website/docs/pipeline-components/retrievers/qdrantsparseembeddingretriever.mdx
Outdated
Show resolved
Hide resolved
docs-website/docs/pipeline-components/retrievers/qdrantsparseembeddingretriever.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: David S. Batista <dsbatista@gmail.com>
davidsbatista
left a comment
There was a problem hiding this comment.
@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.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
docs-website/reference_versioned_docs/version-2.26/integrations-api/qdrant.md
Outdated
Show resolved
Hide resolved
| | GitHub link | https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/qdrant | | ||
|
|
||
| </div> | ||
|
|
There was a problem hiding this comment.
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?
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 :
qdrant-haystackdirectlyFastembedSparseDocumentEmbedderandFastembedSparseTextEmbedderprithvida/...toprithivida/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
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes.