DOC - adding a page about common mistakes - #2269
Draft
rcap107 wants to merge 1 commit into
Draft
Conversation
This is a work in progress PR that should address a problem we have been discussing for a long time, that is providing users with a page that explains common mistakes and pitfalls. At the moment, it's in the how-to's section, but I am not entirely convinced it's the best place. Maybe it should be at the end of the user guide? Also, I haven't properly reviewed the actual content of the solutions. This is more of a POC to see what the page would look like and where to put it.
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
1 participant
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 is a work in progress PR that should address a problem we have been discussing for a long time, that is providing users with a page that explains common mistakes and pitfalls.
At the moment, it's in the how-to's section, but I am not entirely convinced it's the best place. Maybe it should be at the end of the user guide?
Also, I haven't properly reviewed the actual content of the solutions. This is more of a POC to see what the page would look like and where to put it.