/devtools

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 · 1 comment

Comments

Assignees
No one assigned
Labels
Projects
None yet
Milestone
  2.0.0
3 participants
@jennybc @hadley @jimhester
@jennybc
Member

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

@jimhester jimhester added the feature label Apr 11, 2018

@jennybc jennybc referenced this issue May 28, 2018

Closed

message if README.md is out of date #685

@hadley

This comment has been minimized.

Sign in to view
Member

hadley commented May 28, 2018

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

@jimhester jimhester added the vignettes 📜 label Jul 5, 2018

@jimhester jimhester added this to the 2.0.0 milestone Jul 18, 2018

@jimhester jimhester closed this in c509f1e Jul 18, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment