-
Notifications
You must be signed in to change notification settings - Fork 48
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
Updated User Guide #388
Updated User Guide #388
Conversation
8eb9a37
to
4251451
Compare
e1a50e8
to
52926aa
Compare
Creation of the first three sections of the new user guide structure as planned at 2022 Hack-a-thon.
52926aa
to
1cd5cb8
Compare
Updates to contribute.rst and model_setup.rst
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a quick note before you make yourself unnecessary work with the contribute.rst
@@ -0,0 +1,6 @@ | |||
.. _contribute: | |||
|
|||
Contributing to Rayleigh |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We do not need to create a new file for this. There is a file Contributing.md in the main directory that is already integrated in doc/source/User_Guide/index.rst. Just link to it here (or remove the contribute.rst completely and instead link Contributing.md). If you want to make changes to our current text, feel free to change Contributing.md directly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Merging this now so we can move forward on the revised documentation together.
Wait |
Ah, I guess we can fix my comment in a follow-up. |
This is the first part of the updated User Guide outlined at the 2022 Hack-a-thon. It contains new Getting Started, Physics and Math, and Model Setup sections. Please don't merge until additional pieces are complete.