I am developing a rather niche R package that is available on GitHub but with no immediate intention to make it available on CRAN.
A vignette is available, so I suggest that users install the package with
devtools::install_github("jhchou/medianeffect", build_vignettes = TRUE), which works fine once the package is installed.
However, I would like the vignette available to view even without installing the package. With such a niche product, having the vignette available might help people find and understand the use of the package.
Is there a recommended best practice for making the built vignette available as an HTML file without package installation?
One idea I considered was leaving
^doc$ in the
.Rbuildignore file, but removing
doc from the
.gitignore file. I presume this would allow the contents of the
doc directory, which includes the built HTML version of the vignette, to be available on GitHub, but would not interfere with the package build process. Is this correct, or a good idea?
A somewhat similar question was posted in this post, but didn't address my question.