Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write initial documentation #115

Closed
flavioribeiro opened this issue Aug 5, 2014 · 16 comments
Closed

Write initial documentation #115

flavioribeiro opened this issue Aug 5, 2014 · 16 comments

Comments

@flavioribeiro
Copy link
Member

@flavioribeiro flavioribeiro commented Aug 5, 2014

_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
Copy link
Member

@thiagopnts thiagopnts commented Aug 9, 2014

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

@thiagopnts thiagopnts added this to the First Release (0.1.0) milestone Aug 23, 2014
@flavioribeiro
Copy link
Member Author

@flavioribeiro flavioribeiro commented Oct 31, 2014

@chriswiggins
Copy link
Contributor

@chriswiggins chriswiggins commented Feb 14, 2015

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

@thiagopnts
Copy link
Member

@thiagopnts thiagopnts commented Feb 15, 2015

This would be a great start @chriswiggins

@davidaurelio
Copy link

@davidaurelio davidaurelio commented Mar 19, 2015

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
Copy link
Member

@thiagopnts thiagopnts commented Mar 21, 2015

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

@bryfry
Copy link

@bryfry bryfry commented Mar 29, 2015

+1

4 similar comments
@tarkanlar
Copy link

@tarkanlar tarkanlar commented Apr 1, 2015

+1

@snsxn
Copy link

@snsxn snsxn commented Apr 2, 2015

+1

@deedos
Copy link

@deedos deedos commented Apr 10, 2015

+1

@irongomme
Copy link

@irongomme irongomme commented Apr 11, 2015

+1

@thiagopnts
Copy link
Member

@thiagopnts thiagopnts commented Apr 13, 2015

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

@leandromoreira
Copy link
Member

@leandromoreira leandromoreira commented Jul 24, 2015

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
Copy link
Member

@leandromoreira leandromoreira commented Aug 22, 2015

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
Copy link
Member

@towerz towerz commented Aug 22, 2015

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
Copy link
Member

@leandromoreira leandromoreira commented Aug 23, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet