ajdamico / convey

variance of distribution measures estimation of survey data
GNU General Public License v3.0
17 stars 7 forks source link

Add pkgdown::build_site() - and slight intro addition in the readme #363

Closed Edouard-Legoupil closed 2 years ago

Edouard-Legoupil commented 2 years ago

This is what I was suggesting in https://github.com/ajdamico/convey/issues/271

ajdamico commented 2 years ago

hi @Edouard-Legoupil thank you for taking the time to test out pkgdown with convey! i'm not so familiar with pkgdown so apologies if this is a silly question.. i think we would generally want to guide users to read convey's bookdown website and readers might be confused if there's also a competing pkgdown website.. is there a compelling reason to maintain pkgdown in addition to bookdown? i'm not sure we want to drop the bookdown website?

ajdamico commented 2 years ago

thanks again and apologies if i'm overlooking something obvious

Edouard-Legoupil commented 2 years ago

Actually the bookdown you have were 3 Rmd - just pushed them to the vignette folder - with a revised yaml.. Getting all info in a single website, makes it more simple..

ajdamico commented 2 years ago

hi @Edouard-Legoupil thanks again for taking the time to implement this and apologies as I might be a bit slow to understand the new setup.. is there a link to a live website in your repo that I could view to see how this differs from the bookdown site?

Edouard-Legoupil commented 2 years ago

https://edouard-Legoupil.github.io/convey -- just set up the "pages" in the setting - might need some fine polish... image

Edouard-Legoupil commented 2 years ago

and you can customize as required.. https://pkgdown.r-lib.org/articles/customise.html

ajdamico commented 2 years ago

hi Edouard, thanks again! not sure adding the help/reference pages are worth the time of getting the pkgdown site looking as polished as the bookdown site, but good to know this is possible for other work in the future :-) appreciate it