maybe document() should render README.md and README.html

[rcorty]

#1762 was closed based on commit c509f1e

But I don't believe that commit put the building of README.md and README.html into the standard workflow of building a package (which includes document()), it simply made available the build_readme() function.

[jennybc]

The question of rendering README has come up before and I'd agree that, yeah, it has never been fully resolved, from a workflow point of view.

build_readme() is helpful, but it's still not wired into anything automatic, like document().

Related issue:

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

[jimhester]

I would definitely not want document to render the readme, I at least usually have fairly heavy examples in my readme and run document many many times throughout the day. I generally only build the readme when I make a change to the text or am nearing a release.

[jimhester]

I think having the readme as a separate function is fine, but perhaps we should include it in the release issue, release() or similar?

[lock]

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/