Add troubleshooting guide for RAG and reranking in Rankify docs#76
Merged
abdoelsayed2016 merged 4 commits intoDataScienceUIBK:mainfrom Feb 20, 2026
Merged
Add troubleshooting guide for RAG and reranking in Rankify docs#76abdoelsayed2016 merged 4 commits intoDataScienceUIBK:mainfrom
abdoelsayed2016 merged 4 commits intoDataScienceUIBK:mainfrom
Conversation
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
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.
Summary
This PR adds a practical troubleshooting page for users who build retrieval, reranking, and RAG pipelines with Rankify.
The new page focuses on common failure patterns (for example “good retrieval, bad reranking”) and gives concrete checklists that help users quickly localize the most likely source of error.
Changes
docs/docs/troubleshooting_rag_and_reranking.mddocs/mkdocs.ymlas “Troubleshooting RAG & Reranking”Motivation
From my own experience and from issues I often see in RAG projects, many problems are not caused by a single bug in the code, but by small mismatches between:
This page tries to give Rankify users a structured way to:
I am very happy to adjust the wording, structure, or title if you prefer a different style. Feedback is welcome.