search

ProjectMirador / research-and-demos

Proofs of concept for Mirador 3
10 stars 8 forks source link

add basic jsdoc requirement for project #35

Closed mejackreed closed 6 years ago

mejackreed commented 6 years ago

I investigated several documentation build systems. At the moment I think we should hold on those until we have better / fuller understanding of our needs. None that I found could meet all of our needs completely so likely there will need to be a more concerted effort to understand our needs and tooling available.

aeschylus commented 6 years ago

Sounds good Jack. We wrote down more of what we talked about when we last discussed documentation. https://github.com/ProjectMirador/research-and-demos/wiki/Options-for-Managing-Documentation

aeschylus commented 6 years ago

Do we need jsdoc in the package.json?

mejackreed commented 6 years ago

I'm not sure that we do. This requires the format of jsdoc, but leaves up the parsing and usage of it TBD for later.