-
Notifications
You must be signed in to change notification settings - Fork 6
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
Add a quick start guide #1158
Comments
And addition from @SouthEndMusic that is in scope of this issue:
|
Fixes #1158 The quick start guide is now also in our documentation. When I was working on this, I thought about what is the best way to make sure the offline and online one are synchronized, so that when we modify the old module or add new module to the docx, it can be updated in the documentation. I tried conversion between docx and qmd and it doesn't work very well. For now I suggest we should keep to modifying the qmd instead of modifying the docx. --------- Co-authored-by: Bart de Koning <[email protected]>
Many modelers like to learn by example, and end up using https://deltares.github.io/Ribasim/python/examples.html without first reading much of the rest of the documentation.
Right now that page is really just a collection of Python examples. Having a separate tutorial or quick start guide that stands by itself would be valuable. It doesn't have to cover everything, just the essentials. This probably makes sense after this lands: #1110. Then the Python examples would also be much more self-explanatory.
Additional context
Came up in #1154, but also other feedback from first time users.
The text was updated successfully, but these errors were encountered: