Skip to content
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

Merged
merged 5 commits into from
Sep 15, 2022
Merged

Updated User Guide #388

merged 5 commits into from
Sep 15, 2022

Conversation

nicholasjnelson
Copy link
Contributor

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.

Creation of the first three sections of the new user guide structure as planned at 2022 Hack-a-thon.
Copy link
Member

@gassmoeller gassmoeller left a 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
Copy link
Member

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.

Copy link
Contributor

@feathern feathern left a 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.

@feathern feathern merged commit 231049d into master Sep 15, 2022
@gassmoeller
Copy link
Member

Wait

@gassmoeller
Copy link
Member

Ah, I guess we can fix my comment in a follow-up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants