search

Deltares / Ribasim

Water resources modeling
https://ribasim.org/
MIT License
39 stars 5 forks source link

Refactor docs to follow diataxis concept #1541

Closed evetion closed 3 months ago

evetion commented 3 months ago

From the refactor it's quite clear we're missing tutorials, and some API documentation. I also noticed slight overlaps between usage/model concepts.

I didn't write new documentation, only moved pages/paragraphs around and fixed the links I could find. Furthermore, I copied the README.md (but removing the prototype sentence) to serve as a documentation intro, making it slightly like the quarto website itself, as I found the current homepage quite dry.

This will incur merge conflicts for any documentation PR, so I say we merge this quickly, and create new documentation in subsequent PRs.

evetion commented 3 months ago

@visr I've incorporated your comments. Note that home image now links to our assets: . You can see the url if you edit the/this post. The private url is generated on the fly from it. In Quarto(-preview) markdown, it seems the redirect isn't followed (it is here though), so I put it in html tags to be sure.