Add basic troubleshooting guide#5142
Open
gefjon wants to merge 3 commits into
Open
Conversation
JulienLavocat
approved these changes
May 29, 2026
Contributor
JulienLavocat
left a comment
JulienLavocat
left a comment
There was a problem hiding this comment.
LGTM, one minor comment
Contributor
JasonAtClockwork
left a comment
JasonAtClockwork
left a comment
There was a problem hiding this comment.
The documentation looks solid but it looks like due to the location of the doc it doesn't show up for the sidebar. The root folders, like /docs/00300-resources, doesn't have auto-generated entries so either we need to add a manual entry for 00300-resources or move the doc into a folder with auto-generated.
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
3 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.
Description of Changes
Adds a basic troubleshooting guide for some common issues we've seen users encounter.
API and ABI breaking changes
N/a: it's docs.
Expected complexity level and risk
1: it's docs.
Testing
N/a.