tripal / tripal_blast

Provides an user interface to BLAST on Tripal sites.
https://tripal.github.io/tripal_blast/
5 stars 13 forks source link

Current Documentation #104

Open laceysanderson opened 6 months ago

laceysanderson commented 6 months ago

We NEED current documentation for the upgraded version of this module!

I started this with PR #103 and am now creating this issue to document the process.

That PR adds a skeleton of documentation for this module (more a plan then actual documentation at this point) using mkdocs and the Material Theme.

How to develop these docs:

cd docs
docker build --tag trpblast:docs ./
docker run --rm --volume=$(pwd):/tripal_blast trpblast:docs mkdocs build
open site/index.html

To see something like the following: image

And the current navigation is:

laceysanderson commented 6 months ago

Docs now include installation information: image

image