pkgdown website for released or dev version of the package?

Tags: #<Tag:0x00007fbcaca579c0>

All rOpenSci packages now have a pkgdown website that’s updated with each commit to master. With the way the system works at the moment, we cannot use pkgdown’s “auto” mode (creating a website for the released version at the root, and one for the dev version under dev/).

The website might document behaviors/functions that are not released on CRAN. Should this be avoided (by using a dev branch until release)? If not, how to make it clear?

Opinions are welcome.

Related issue in the dev guide repo.

For mlr3 we are using the auto mode via CI deployed pkgdown builds.

The version in the DESCRIPTION file decides whether the site is deployed to . or ./dev.
If it contains a .9000 it will be dev, otherwise it will be deployed to the “release” page.
By default the CRAN release site is shown to the user.
This approach only works if one sticks to the model of strictly using .9000 versions for dev cycles and only do different for that one commit which should reference the latest CRAN release.

We added some links to the README (release / dev) which link both versions.
It would probably be better to have them sticky in the menu bar.

Example: https://mlr3.mlr-org.com/dev/

1 Like

My ideal scenario would be that we support multiple versions on our docs server (e.g., current CRAN version [i.e., should be the same as most recent git tag], and perhaps current dev version) - but we don’t support that right now. readthedocs does this nicely.