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

arrange sections of cookbook and add some introductory content #158

Merged
merged 4 commits into from
Sep 25, 2024

Conversation

jacobvjk
Copy link
Member

@jacobvjk jacobvjk commented Sep 25, 2024

relates to #104

  • cookbook.Rmd gains a section "Overview" that covers:
    • What is the PACTA for Supervisors analysis?
    • Who is this tool built for?
    • What can the results of the PACTA for Supervisors analysis be used for?
    • What are the main steps of the analysis?
  • this section is meant to give a high level overview of what the reader can expect from the tool in terms of analysis and from the cookbook in terms of documentation
  • Moves other sections around to fit the structure of the cookbook outlined in the related GH issue

NOTE

  • this PR is a draft version of the "Overview" section. The final version may look different and will consider substantial reviews.
  • To be clear, this PR only addresses the first checkbox of the linked GH issue

@jacobvjk jacobvjk marked this pull request as ready for review September 25, 2024 14:12
@jacobvjk
Copy link
Member Author

@jdhoffa @cjyetman I am sure the overview section can be improved, but this is a first draft that I think covers many of the points at a high level that we are aiming to achieve with the cookbook. Unless you see any major issues with the content, I would suggest to prepare the draft first and improve each of the sections with inputs from our non-tech colleagues later

vignettes/cookbook.Rmd Outdated Show resolved Hide resolved
Co-authored-by: CJ Yetman <cj@cjyetman.com>
@jacobvjk jacobvjk merged commit 0f55328 into main Sep 25, 2024
9 checks passed
@jacobvjk jacobvjk deleted the draft-cookbook-intro branch September 25, 2024 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants