Closed charlesreid1 closed 6 years ago
Remaining to do:
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.
This pull request is ready, but it should happen together with #83, since it documents several changes made in #83.
Review in progress
Closed in favor of https://github.com/dahak-metagenomics/dahak/pull/95
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 intodocs/
. 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.README.md
(the first page the user sees when they visit the repo) anddocs/index.md
(the first page the user sees when they visit the documentation) will contain the same infoworkflows/
-->docs/workflows/
Issues that we won't deal with:
dockerSnakefile
, but we need to figure out a better plan for these.)Merge Checklist