docs: add a structured troubleshooting guide for UltraRAG workflows#352
Merged
xhd0728 merged 2 commits intoOpenBMB:mainfrom Apr 8, 2026
Merged
Conversation
xhd0728
approved these changes
Apr 8, 2026
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
2 participants
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 small docs-only troubleshooting guide for UltraRAG workflows.
It includes:
docs/debug_rag_workflows_zh.mddocs/README_zh.mdWhy
This is a minimal documentation follow-up to #320.
The intention here is only to provide a practical and lightweight guide for users when a workflow output looks suspicious and they want a clearer way to narrow the problem down step by step.
The guide organizes debugging into four layers:
Scope
This PR is intentionally small:
Additional note
The guide is written to match UltraRAG's current documentation style and workflow-oriented usage.