[WIP] Add advice on checking built docs to dev documentation #1180
Conversation
This file contains 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
TorkelE
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Very WIP. wrote something on my laptop and uploaded, will go through and make it nice (and check that it is actually correct) when I get back to my desktop.
Adds section to the dev docs on how to check the docs (if nothing else so I can see how to do it next time I forget). Also added a note of the Code Spell Checker. Had no idea about it for a long time, but as a non-native speaker it helps a lot.
At some point we can think of if there is a nicer way to structure this, but for now I figured it is probably best to put in stuff there.