docs: add missing retrievers to index table#11699
Open
milljer wants to merge 1 commit into
Open
Conversation
|
@milljer is attempting to deploy a commit to the deepset Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issues
Proposed Changes:
Six retriever components had full documentation pages and were present in sidebars.js but were missing from the retriever index table in both current and versioned docs. Added the following entries to
docs-website/docs/pipeline-components/retrievers.mdxanddocs-website/versioned_docs/version-2.30/pipeline-components/retrievers.mdx:This is the same type of fix as my previously merged PR, which addressed similar navigation gaps for preprocessor and sidebar components.
How did you test it?
Verified that each component has a corresponding .mdx file in both the current and versioned retrievers directories. Verified alphabetical placement of each new entry relative to existing entries.
Notes for the reviewer
While making these insertions, I noticed that some existing rows in the table appear to be out of alphabetical order (e.g.,
FilterRetrieverandMongoDBAtlasEmbeddingRetriever). I left those untouched to keep this PR focused, but I am happy to fix the ordering in a follow-up PR or as part of this one if you prefer.For
MongoDBAtlasFullTextRetrieverspecifically: althoughMongoDBAtlasEmbeddingRetrieveris itself out of alphabetical order in the table, I insertedMongoDBAtlasFullTextRetrieverdirectly after it since the two components are closely related and it would be confusing to separate them. If the ordering is corrected in a future PR, both MongoDB Atlas entries can be moved together.This PR was produced with AI assistance (Claude). I have reviewed all changes and verified them manually.
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes.