Research Documentation Generators

[mimiflynn]

JSDoc?

[SandyGifford]

JSDoc!

[SandyGifford]

Seriously though... JSDoc

[SandyGifford]

I guess we should make a separate branch to add the documentation to existing functions?

[SandyGifford]

Or should this just go right in Main since it's an ongoing thing...

[SandyGifford]

Been using API Blueprint - it's nice, but a bit redundant to GItHubs ReadMe format, I think.

[mimiflynn]

I think a separate branch for initial implementation would be good.

Tell me more about API Blueprint and why you think its redundant? Can it be used instead / with of the Github readme? Like to generate them?

I'll google it when i get a moment ;)

[SandyGifford]

API BluePrint is written in a language very similar to the GitHub ReadMe markdown, but specializes in generating extra bits for things like request status (ie: 500, 404, 403 etc). I think it might be excessive for what we're doing and doesn't seem to have a direct tie-in to code (like an NPM module). I think JSDoc should be robust enough, is there a markdown template for JSDoc?

[SandyGifford]

Because if not I'm going to make one