Feature / Documentation

[Bratanov]

Work in progress

This is my second attempt on this.

Problem with previous attempt (https://github.com/Bratanov/community-driven-radio/pull/31) was that the jsdoc generated .html files had to be included in PR's in order to be seen in the github pages page (from docs folder in master branch - Reference ).

This time I'm using the gh-pages branch (Reference) , and a script is included which will move all documentation related files (and generated on-the-go jsdocs) to it.

Demo: http://bratanov.github.io/community-driven-radio/ (Will update it as I work on this PR)

Done:

• Basic structure for the .md files docs, generator setup for the jsdocs eg.
  • Files you see here: http://bratanov.github.io/community-driven-radio/ are the .md files from the docs folder,
  • Files you see here: http://bratanov.github.io/community-driven-radio/jsdocs/ are generated with jsDoc from the comments in the .js files
• Github pages publishing script (npm run publish-docs)
• Documented the classes/methods for the JSDocs
• Classes quick refference (http://bratanov.github.io/community-driven-radio/classes-quick-reference/) with a nice little chart