-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation restructure #151
Merged
Merged
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
The documentation has been reorganised to better allow distinct kinds of documentation, with distinct audiences, to be written. This involves splitting the documentation into several distinct sections based on how it should be written. This is Tutorials, How-to guides, References, and Explanations. * Tutorials are for people learning their way around. * How-to guides answer the "how?". * References answer the "what?". * Explanations answer the "why?". This is a commonly used, and well regarded documentations style used by projects such as NumPy. More information can be found here: https://documentation.divio.com/
Still needs more splitting though.
This PR just restructures the documentation. It will be an ongoing effort to expand and update the documentation. |
To aid review, here is a rendered version of the documentation. |
jfrost-mo
requested review from
jwarner8
and removed request for
Sylviabohnenstengel
July 10, 2023 09:37
jwarner8
reviewed
Jul 11, 2023
worth also commenting on improved quality assurance as well as preventing effort on duplicated code. I.e. adhoc scripts in different peoples dirs may have bugs, whereas CSET at least is scientific/technically reviewed code so more likely to catch bugs in diagnostics.
Yeah, that would be a good addition. I’ll add it.
|
jwarner8
approved these changes
Jul 11, 2023
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.
The documentation has been reorganised to better allow distinct kinds of documentation, with distinct audiences, to be written.
This involves splitting the documentation into several distinct sections based on how it should be written. This is Tutorials, How-to guides, References, and Explanations.
This is a commonly used, and well regarded documentations style used by projects such as NumPy.
More information can be found here: https://documentation.divio.com/
Fixes #146