joss icon indicating copy to clipboard operation
joss copied to clipboard

Published 20 hours ago • verified publisher icon openjournals

Adding a field to link the documentation in the JOSS Paper template

Open rasbt opened this issue 7 years ago • 1 comments

The question whether a link to a documentation is necessary in the paper or not came up here: https://github.com/qiime2/q2-sample-classifier/issues/133

I think that it would be generally useful to have a field in the template to provide a link to the documentation in an easy, discoverable manner. I.e., maybe under "Software"

screen shot 2018-09-27 at 12 55 26 pm

There could be even two fields:

  • Tutorials
  • API Documentation

rasbt avatar Sep 27 '18 17:09 rasbt

It is my understanding the the software repository should include a README with all the links to documentation, tutorials, etc. (and their completeness is part of the review).

As links to documentation can change, it seems best to just have the one link to the repo.

labarba avatar Sep 27 '18 20:09 labarba