Documents

[teamikl]

Make modern documentation on github pages. Getting started, Tutorial, API Docs, Reference, Slides, Developer guide etc.

• [ ] contribute guide CONTRIBUTING file
  • [ ] workflow detail in wiki
• [ ] gulp task to generate API document
  • [ ] publish to github.io
• https://guides.github.com/activities/contributing-to-open-source/

[teamikl]

Dgeni - Documentation Generator https://github.com/angular/dgeni

[teamikl]

Learn documentation manner from Angular project

Example comment for JSHint and API document https://github.com/angular/angular.js/blob/master/src/Angular.js

NOTE: how to write document for Event ?

[teamikl]

• https://www.npmjs.org/package/dgeni-markdown
• https://www.npmjs.org/package/grunt-dgeni

[teamikl]

How to write API doc for asynchronous function? which result is pass to callback or call continue function as result.

There is @callback annotation, also @event for events.

• [ ] add document generate task to gulp
• [ ] add deploy apidoc task (commit to gh-pages branch)