-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Apply versioning to our documentation #1945
Comments
Unlikely to be done in Quarto itself: quarto-dev/quarto-cli#474. They advise not versioning documentation (but writing a single clear documentation). |
We could start using callout notes to hint users from which version certain features are available, especially for unreleased features. And we should fix #666 so we always have frozen PDFs as a backup. |
@JoostBuitink added a version switcher seemingly based on the Documenter version switching code to Wflow in Deltares/Wflow.jl@8605bf1#diff-bf446527f10d7498864186e82612d5a93f7d2b63148550644c6cdf2bfbeab4b6. See e.g. https://github.com/Deltares/Wflow.jl/blob/06b1b2b935fb2612535522d9fccabe2c5be8eec9/docs/_static/version.js and https://deltares.github.io/Wflow.jl/dev/. In the https://github.com/Deltares/Wflow.jl/tree/gh-pages branch then each version gets its own folder. Although I am warming up to the Quarto recommendation not to version documentation as well. |
I'll pass the credit where credit is due ;) I have based this upon the work done by @dalmijn for the Delft-FIAT docs (https://github.com/Deltares/Delft-FIAT). This is basically a slighly simplified version of his version-switcher. I get the arguments made by the quarto devs, but still believe it is very valuable to have versions of the documentation connected to specific releases. |
As we now have things documented (such as Delwaq coupling functionality) that is not released yet (found by a user during DSD).
In documentation we will add from which version functionality available is. Should be part of our review proces.
The text was updated successfully, but these errors were encountered: