Write initial documentation

[flavioribeiro]

_5 Upvotes_ # You can find the documentation at http://clappr.github.io

We should describe how clappr is structured and how plugins works - showing the differences between container plugins, playback plugins and "global" ones. Would be quite interesting to have at last one tutorial describing step-to-step how to write a mp3 player or a slideshow player.

We should also create a session like nginx's 3rd party modules to store external modules like bemtv p2phls plugin.

[thiagopnts]

We can take a look on tools like YUIDoc to generate docs for the APIs. I think this can be integrated with gulp easily.

[flavioribeiro]

readme.io

[chriswiggins]

What about something like an API.md document? To list all the javascript methods that can be called?

[thiagopnts]

This would be a great start @chriswiggins

[davidaurelio]

Hey there, I’d really like to use clappr and maybe contribute to development. Unfortunately, the lack of documentation makes everything beyond instantiating a player really hard and a guessing game.

Please invest some time to provide great documentation, that could really provide a kickstart for the project.

[thiagopnts]

@davidaurelio You're definitely right about this. I'll start to focus on this in the next days.

[bryfry]

+1

[tarkanlar]

+1

[snsxn]

+1

[deedos]

+1

[irongomme]

+1

[thiagopnts]

Following @chriswiggins idea, I started to draft an API.md file. Feedbacks are welcome.

[leandromoreira]

We may use something similar to this http://leandromoreira.github.io/clappr-docs/classes/Player.html#method_constructor

it's almost one year old 🎂

[leandromoreira]

At Aug 9, 2014 @thiagopnts suggested yuidoc and we did it 👊

You already can check the initial documentation, mostly covering the github's home page and thiago's API documentation.

We still need to better integrate this to our build but I think the first step was done. can we close this @flavioribeiro @thiagopnts @towerz @bernardocamilo @barbosa ?

[towerz]

Great job, @leandromoreira! 🍻

I'm ok with closing this one, now we can start moving towards tutorials and other kinds of documentation, as well as improving our test coverage.

[leandromoreira]

@chriswiggins @davidaurelio @bryfry @tarkanlar @snsxn @deedos @irongomme you can check the initial documentation at http://clappr.github.io/