Troubleshooting Documentation #641
Merged
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
Contributor
Author
|
When building these docs there is an error: I'll look into and see if the new .rst file is causing any issues. |
jtgrasb
reviewed
Jul 15, 2021
Contributor
jtgrasb
left a comment
There was a problem hiding this comment.
Just small, grammatical changes. Overall, should be very helpful for new users and looks good once the building error is fixed.
Co-authored-by: jtgrasb <87095491+jtgrasb@users.noreply.github.com>
Contributor
Author
|
@Jeffalo1 I updated the new page based on your suggestions. I also pulled dev into this branch so that the docs build properly now. |
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.
This PR adds a Troubleshooting section to the User Manual. The first subsection covers:
The second subsection describes several numerical test cases users should follow when developing a novel case. This includes checking hydrostatic stability, decay tests, viscous drag, etc. For each test case, details are provided on typical errors and suggested solutions.
The third subsection contains a FAQ with a description, error message, and solutions for commonly asked github issues, including:
It it my hope that this page will set standards on using the issue board and help users address their own questions. It serves as a convenient place to point users with common support questions. Hopefully this decreases the time required to maintain the issue board. The most common issues can be added to the FAQ if desired. The debugging steps include reviewing past issues which should provide the same information.