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

Add documentation #13

Closed
3 tasks
d2hydro opened this issue Oct 2, 2023 · 2 comments
Closed
3 tasks

Add documentation #13

d2hydro opened this issue Oct 2, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@d2hydro
Copy link
Contributor

d2hydro commented Oct 2, 2023

Setup a documentation with similar setup as Ribasim, including

  • index, so the broader public can read what we are doing
  • glossary; so we conform to the same jargon
  • ...
@d2hydro d2hydro self-assigned this Oct 2, 2023
@d2hydro d2hydro converted this from a draft issue Oct 2, 2023
@d2hydro d2hydro added the documentation Improvements or additions to documentation label Oct 2, 2023
@visr
Copy link
Member

visr commented Oct 10, 2023

Moved message from #18, didn't realize there was already a docs issue, apparently I wasn't watching the repo!

I plan to use Quarto, similar to https://github.com/Deltares/Ribasim. With this we can easily include notebooks into our documentation as well. Some points for our developer docs:

          Some things noticed:
  • Win-users (expect the majority in our community) need to use powershell in the pixi install instructions: https://deltares.github.io/Ribasim/contribute/python.html#setting-up-pixi. Something Google tells you immediately, but nevertheless most will default try in CMD and fail.
  • pixi run install is something we need to add in the docs
  • pixi run python is something we need to add in the docs as well

Other than that, works like a charm!

Originally posted by @d2hydro in #17 (review)

@visr visr mentioned this issue Oct 10, 2023
@d2hydro d2hydro removed their assignment Mar 2, 2024
@visr
Copy link
Member

visr commented Jun 25, 2024

Closing as we have a minimal docs set up. Needs more work, but best to have more specific issues with the documentation label.

@visr visr closed this as completed Jun 25, 2024
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Ribasim NL Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: ✅ Done
Development

No branches or pull requests

1 participant