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

1st Round cleanup/re-org of pkgdown vignettes #356

Closed
4 tasks done
LittleBeannie opened this issue Mar 8, 2024 · 0 comments · Fixed by #357
Closed
4 tasks done

1st Round cleanup/re-org of pkgdown vignettes #356

LittleBeannie opened this issue Mar 8, 2024 · 0 comments · Fixed by #357
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@LittleBeannie
Copy link
Collaborator

LittleBeannie commented Mar 8, 2024

This issue involves the initial round of cleanup and reorganization of the pkgdown vignettes. The main objective is to remove duplicated content and restructure the table of contents on the pkgdown/article page.

For instance, the content of the following vignettes primarily focuses on the implementation of R functions, which can be incorporated as examples within the help files.

  • usage-expected-accrual.Rmd -> examples in expected_accrual.R
  • usage-expected-time.Rmd -> examples in expected_time.R
  • usage-summary-as-gt.Rmd -> examples in summary.R and as_gt.R
  • best-practice-npe-accuracy.Rmd -> examples in gs_power_npe.R

With this issue resolved, we will proceed with another round of cleanup for the vignettes, tentatively planned for around 2024 Q2. The focus of this cleanup will be on the content of the vignettes, including tasks such as adding new material, dividing certain vignettes into two, or merging multiple vignettes.

@LittleBeannie LittleBeannie added the documentation Improvements or additions to documentation label Mar 8, 2024
@LittleBeannie LittleBeannie self-assigned this Mar 8, 2024
@LittleBeannie LittleBeannie linked a pull request Mar 8, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant