FR: Add a link to the live guide directly to the GH source
MichaelChirico opened this issue · 1 comments
I really like that the tidyverse style guide (style.tidyverse.org) always links out directly to the GH source:
I think it reduces the contribution friction a lot for casual readers -- if I spot a typo or find some wording confusing, I am just one click away from improving it. With the current website, I had to go search for 'rdevguide github' to find the source.
This is already possible, please see: https://contributor.r-project.org/rdevguide/introduction.html#how-to-contribute-to-this-guide
It may be less obvious as we are using the bookdown::gitbook format vs bookdown::bs4_book. I do like the navigation in bs4_book and the search is better (results show the section not just the chapter). On the other hand, it does not have in-built accessibility features (Sepia/Night mode, large font) and does not have a PDF/EPUB option. I don't think the "visual effects" are critical as there are probably browser extensions that do just a good job if not better. But the PDF/EPUB option is helpful for those that want to work offline/have limited internet access, which I think is a deal breaker.
So I'll close this issue as the requested feature is there - if anyone wants to work on an "all singing all dancing" bookdown theme, I'd be happy to hear about it (note we considered Quarto last September and put that as low priority as there were various accessibility issues at the time, this may change in future).
@SaranjeetKaur plans to revise the documentation on how to contribute to the guide itself, perhaps she can invite you to review the changes to see if it helps make this feature clearer to readers.