search

sanjaynagi / AmpSeeker

A snakemake workflow for amplicon sequencing
https://sanjaynagi.github.io/AmpSeeker/
0 stars 3 forks source link

Make documentation webpage #35

Closed sanjaynagi closed 1 year ago

sanjaynagi commented 1 year ago

As well as the results Jupyter-book, we also want a jupyter book which will be public, and contain the documentation, for things like

This will be hosted within the AmpSeeker repo using github pages.

sanjaynagi commented 1 year ago

This will also involve removing the introduction bits from the current results-book.

sanjaynagi commented 1 year ago

I suggest we change the name of the current results book to 'ampseeker-results' and then make a second jupyter book called 'ampseeker-docs'.

In the results-book, we just have a home-page which describes AmpSeeker and how the results are presented.

In the docs, we have things like how to clone, install, configure, and run the snakemake workflow, as well as troubleshooting and contributing.

sanjaynagi commented 1 year ago

The docs we will build ourselves, the results-book will be generated by snakemake.