efacilitation/eventric

eventric app: API Docs

Closed this issue · 1 comments

As a developer
I want to easily access and update the API documentation
So that I can lookup the eventricjs behaviours


We document the code itself using jsdoc comment blocks over classes and methods. To actually parse jsdoc we use dgeni. This has the benefit that we can

  • Versioning Documentation together with code
  • Reusing jsdoc output (json) to build a "list of behaviours" in a Context

To access the documentation we provide the gulp task gulp docs:watch

  • Builds the documentation
  • Starts a webserver which serves an angular app that provides a nice ui for the docs
  • Watches for src-file changes and refreshes the ui if something changes

Releasing the docs with gulp docs:release will push the doc-build into the gh-pages branch.

All stuff regarding the eventric-app is now living in a seperate repository.