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

Refactor vignettes using diataxis principles #30

Open
cpauvert opened this issue Sep 7, 2023 · 0 comments
Open

Refactor vignettes using diataxis principles #30

cpauvert opened this issue Sep 7, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@cpauvert
Copy link
Member

cpauvert commented Sep 7, 2023

A possible option to reduce the length of the vignettes is to split into 3 vignettes:

  • Import data
  • Process data
  • Cherry-pick

While examples are part of the vignettes, additional examples could be added that would not make it to the examples section of the function but "just" in the vignettes.

Make sure to distinguish tutorials from how-to using https://diataxis.fr/
@cpauvert cpauvert added the documentation Improvements or additions to documentation label Sep 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@cpauvert