dahak-metagenomics / dahak

benchmarking and containerization of tools for analysis of complex non-clinical metagenomes.
https://dahak-metagenomics.github.io/dahak
BSD 3-Clause "New" or "Revised" License
21 stars 4 forks source link

Add read filtering and taxonomic classification documentation #84

Closed charlesreid1 closed 6 years ago

charlesreid1 commented 6 years ago

This adds the initial materials for an mkdocs documentation site.

The documentation index is currently juts a copy of the repository README.

We are creating a duplicate documentation structure (duplicating the workflow documentation already in workflows/), and revising these documents as they are migrated over into docs/. For example, we convert README to index. We copy workflow overviews into docs/ folder workflow documents. This creates a front-end (searchable documentation with mkdocs-material) that is the "finished product" documentation.

Issues that we won't deal with:

Merge Checklist

charlesreid1 commented 6 years ago

Remaining to do:

charlesreid1 commented 6 years ago

Ready to merge.

Will also be able to use this to provide a final working documentation site at https://dahak-metagenomics.github.io/dahak once we merge this and build it.

charlesreid1 commented 6 years ago

This pull request is ready, but it should happen together with #83, since it documents several changes made in #83.

brooksph commented 6 years ago

Review in progress

brooksph commented 6 years ago

Closed in favor of https://github.com/dahak-metagenomics/dahak/pull/95