Chado icon indicating copy to clipboard operation
Chado copied to clipboard

Core goal: Documentation

Open laceysanderson opened this issue 5 years ago • 6 comments

I wonder if moving the documentation for Chado into this repo via readthedocs would make documentation for chado more visible. Additionally, I think it would make it easier for contribution of "how to use chado" (i.e. best practices and/or just different methods). For example, the recent issue on mRNA/Gene versioning (https://github.com/tripal/tripal/issues/645) has shown multiple common ways in use -it would be great to document these! While we could put them on the gmod wiki, I worry these docs get lost there.

Reasons for including docs in github:

  • easy to tag an issue as needing updates to documentation which helps keeps the documentation up to date
  • makes it easier to find/navigate all the documentation without getting lost in all the other gmod docs
  • easy to contribute changes ("Edit in gihub" automatically creates a fork and PR)
  • allows us to curate docs which improves quality (I volunteer to keep up with this although I would Love help)
  • I've noticed moving Tripal docs to github makes me feel more rewarded for updating docs since people actually see I'm making updates

Downsides:

  • documentation in multiple places (gmod wiki, readthedocs, schemaspy). This could be mitigated by good external linking making readthedocs the primary source

laceysanderson avatar Oct 08 '18 15:10 laceysanderson