project-ivi / ivi

Interactive Visual Interpreter
7 stars 3 forks source link

JSDocs #130

Open gjbunyea opened 7 years ago

gjbunyea commented 7 years ago

Context

Bug fix? No

Add JSDocs and documentation so our docs are fuckin sweet

Current v Expected Results

Current: our docs are on wiki Expected: jsdocs builds our docs and they are hosted on the site

Acceptance Criteria

project-ivi.github.io/docs leads do our documentation that is generated by jsdocs

Greg - set up for build/deploy All else - document in the files

gjbunyea commented 7 years ago

If you add /*eslint valid-jsdoc: "error"*/ to the top of a file, eslint will validate your jsdoc stuff