Documentation check

[hadley]

• Run roxygen2::roxygenise() and check no files changed
• Check that pkgdown::build_reference_index() is ok
• Spellcheck?
• URL check?

[hadley]

Look at what Shiny does.

[gaborcsardi]

Do you still want these as separate actions? Or as an example workflow that does all of them?

[hadley]

Let's wait for @schloerke since this is something that Shiny already does.

We should also think about compiling translation files .mo as part of this step.

[gaborcsardi]

Hadley, do you still want an action and/or workflow for these?

TBH it does not seem practical to introduce new jobs for these.

• Maybe the roxygen2::roxygenise() check could be part of the check-r-package action?
• pkgdown we already "check" in the pkgdown action, which now also runs for PRs
• Spellcheck could be also part of the check-r-package action, optionally.
• We could turn on URL checks in R CMD check, or run the URL checks as part of the check-r-package action.

[hadley]

Yeah, I think the best way to handle these would be to introduce additional features/functions in rcmdcheck, and then set those options for actions.

[gaborcsardi]

This is blocked by new features in rcmdcheck.

[AlexAxthelm]

Our team has a pretty simple workflow that we call that has been handling our needs for this
https://github.com/RMI-PACTA/actions/blob/main/.github/workflows/R-check-docs.yml