Book structure

[sckott]

We're going to have a distinct set of repo types in the WILDS - they are:

• R package
• Python package
• WDL workflow
• Translational Analytics analysis
• Dockerfile/docker container

We'll want to include content in this guide specific to each of the 5 types above. How should that be done?

Right now I'm thinking we use Parts - where the first part is general code/etc., and the second part is chapters specific for each repo type. And at the beginning of the guide discuss this structure so it's clear to readers

[sckott]

As a starting point, what about this structure? Thoughts @seankross @tefirman ?

Notes:

• Software packages: covers R and Python packages. Is it better to have separate book parts for R and Python? Or have R and Python contained within topic chapters as is currently the setup?
• I don't know if there's enough content for workflows, TA analyses, Docker to have multiple chapters. Do you know @tefirman ? if not, we could do something like the below

[tefirman]

Thanks for mocking this up, @sckott!

• For Software Packages, I don't have a strong preference, but I think I lean towards splitting out R and Python into their own book parts. I feel like readers are going to come in with a specific coding language in mind and that would make it easier to navigate.
• As far as WDL and Dockerfile repos, I agree that we won't have a ton of documentation for those, so I think I lean towards the second layout. I already have something mocked up for the Docker repo that I can add in that section!

[sckott]

Yeah, that's probably a good idea to have "entry points" that people can easily find - person A will be looking for python stuff, and person B for R stuff, and be easier to find that if there's a section for each of them.

Okay, we can do this second layout for other repos at least to start, and use some other structure later if there's a lot of content