search

UofS-Pulse-Binfo / analyzedphenotypes

Tripal/Drupal support for analyzed phenotypic data including data loaders, exporters, trait pages and summaries on germplasm pages.
GNU General Public License v2.0
0 stars 1 forks source link

Official Documentation for release #30

Closed laceysanderson closed 5 years ago

laceysanderson commented 5 years ago

We need official documentation beyond just the readme for release of this module. I'm opening this issue as a place for discussion, planning and outlining such documentation. Additionally we will use this issue as a launching point for documentation development but decided that documentation is not subject to the typical PR review.

laceysanderson commented 5 years ago

I set-up this module according to https://github.com/UofS-Pulse-Binfo/KnowPulse/blob/master/ReadtheDocs/README.md#starting-docs-for-a-new-module except for steps 3-4. You can see the result here: https://analyzedphenotypes.readthedocs.io/en/latest/.

Now you just need to add real documentation and update your readme to point to the new docs. Use branch 30-docs.

Example Docs: https://nd-genotypes.readthedocs.io/en/latest/ Example README: https://github.com/UofS-Pulse-Binfo/nd_genotypes/blob/7.x-3.x/README.md

laceysanderson commented 5 years ago

The documentation was written by @reynoldtan and integrated into readthedocs by myself. It is now live!