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.

Sign up for GitHub

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

Jump to bottom

Move portion of the main README to vignette(s) #95

Open
jrdnbradford opened this issue Nov 20, 2024 · 1 comment
Open

Move portion of the main README to vignette(s) #95

jrdnbradford opened this issue Nov 20, 2024 · 1 comment

Comments

@jrdnbradford
Copy link
Contributor

jrdnbradford commented Nov 20, 2024 •
edited
Loading

Everything below the Usage heading should probably be in a vignette, for instance. This is complicated by a current vignette (using_robotstxt.Rmd) that shares much of the content of the main README.
@petermeissner
Copy link
Contributor

Just a comment:
The use of a long README was deliberate.
Vignettes are a great idea, but they are much less accessible:
E.g. as far as I know, most Rusers do not know about them or it takes some time to learn that vignettes exist.
Also, vignettes are harder to find. The README is somethingg people will always find and find first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@petermeissner @jrdnbradford