Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do something about README.Rmd --> README.md #1762

Closed
jennybc opened this issue Apr 10, 2018 · 2 comments
Closed

Do something about README.Rmd --> README.md #1762

jennybc opened this issue Apr 10, 2018 · 2 comments
Milestone

Comments

@jennybc
Copy link
Member

@jennybc jennybc commented Apr 10, 2018

Currently README.md can grow stale because nothing one does in the normal course of development will cause it to be re-rendered.

We've discussed that it should be probably rendered via devtools::document().

pkgdown is also relevant, but it was recently decided that it's confusing for pkgdown::build_site() to modify files outside of docs/.

Also connected to vignette development workflows, which are up in the air:
https://github.com/r-lib/devtools/issues?utf8=✓&q=is%3Aissue+is%3Aopen+vignette

@hadley
Copy link
Member

@hadley hadley commented May 28, 2018

Rebuilding README.md (+ improved vignette workflow) should also involve installing development package to a temporary library.

@jimhester jimhester added this to the 2.0.0 milestone Jul 18, 2018
@jimhester jimhester closed this in c509f1e Jul 18, 2018
@lock
Copy link

@lock lock bot commented Jan 14, 2019

This old issue has been automatically locked. If you believe you have found a related problem, please file a new issue (with reprex) and link to this issue. https://reprex.tidyverse.org/

@lock lock bot locked and limited conversation to collaborators Jan 14, 2019
HughParsonage added a commit to HughParsonage/devtools that referenced this issue Jul 2, 2019
This build a README.md from a README.Rmd

Fixes r-lib#1762
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants