Skip to content

docs: add quick RAG triage checklist to RAG troubleshooting page#1112

Open
onestardao wants to merge 1 commit intoopen-webui:mainfrom
onestardao:main
Open

docs: add quick RAG triage checklist to RAG troubleshooting page#1112
onestardao wants to merge 1 commit intoopen-webui:mainfrom
onestardao:main

Conversation

@onestardao
Copy link

Summary
this PR adds a small “Quick RAG Triage Checklist” section to the existing RAG troubleshooting page. it gives users a symptom first table that maps what they observe to the most likely failure area, and points them to the relevant sections already documented on the same page.

Why
RAG issues are often reported as “hallucination” but the root cause is usually context side: ingestion, extraction, chunking, embeddings, retrieval, or context window limits. a short triage table helps users and maintainers converge faster, reduces repetitive support threads, and improves the signal quality of bug reports.

What changed
added a single section near the top of the RAG page:
Quick RAG Triage Checklist
a compact table (P01–P12) mapping symptom to likely pattern and which section to read first.
no other docs changes.

Scope
docs only
one file changed: docs/troubleshooting/rag.mdx

Testing
docs build not run locally in this PR (content only change)
no runtime behavior changes

Added a Quick RAG Triage Checklist to assist users in diagnosing common issues with RAG responses. Expanded explanations and solutions for various RAG-related problems.
@pr-validator-bot
Copy link

ℹ️ Documentation PR Guidelines

👋 Welcome! This is an automated message posted on all new documentation PRs to help guide our contributors. Just because this comment appeared doesn't mean you have done anything wrong!

Please ensure you're using the correct branches:

Target branch (where you're merging TO):

  • dev branch: For documentation related to upcoming Open WebUI releases (new features, new environment variables, anything dependent on unreleased versions and unreleased features/fixes/changes)
  • main branch: For content that can go live immediately (fixes, tutorials, documentation not dependent on unreleased features)

Source branch (where you're merging FROM):

  • If targeting dev, create your branch from your fork's dev branch
  • If targeting main, create your branch from your fork's main branch
  • ⚠️ Mismatched branches can and will result in unwanted file changes being included in your PR!

If your docs PR depends on a pending PR in open-webui/open-webui:

  • Convert this PR to DRAFT mode!
  • Link to the related main repo PR in your description for clarity
  • We'll review both together once the PR on the main repo is merged

Please adjust your PR target branch, source branch, and/or draft status accordingly if needed.

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.

2 participants