Design index template(s)

[vdauwera]

I'm starting to plan how we'll make the tooldocs available on the GATK website, and specifically what organization layouts we want to offer to users. There are three main patterns that people tend to follow when looking for docs, which would be best served by offering separate index pages:

• full alphabetical list of all tools
• subset by top-level package (in the GATK world, core vs protected vs Picard), then alphabetical
• functional breakdown (QC vs bam processing vs variant discovery etc)

Note that this would only apply to tools, proper -- read filters, annotation modules, metrics collections (in Picard) etc still make sense to categorize separately in any case.

That being said, I need to think a bit more about the UX side of things before implementing anything. TBC. Comments welcome.

[vdauwera]

Yo @droazen @lbergelson can you make me a writer on this repo?

[cmnbroad]

@vdauwera I added you as a writer. One comment - depending on how your thinking evolves, it may be better to keep some of what you're describing in the GATK or Picard repositories, so Barclay can remain agnostic about who the docgen consumer is.

[vdauwera]

Thanks!

I agree about keeping gatk/Picard specific details out of barclay; but I'm thinking it may be useful to make index templates that provide generic schemas for the different patterns of organization. So I plan to work from here and extract things that become too specific.