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

Comments

Projects
None yet
@flavioribeiro
Member

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

This comment has been minimized.

Show comment
Hide comment
@thiagopnts

thiagopnts Aug 9, 2014

Member

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

Member

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

This comment has been minimized.

Show comment
Hide comment
@chriswiggins

This comment has been minimized.

Show comment
Hide comment
@chriswiggins

chriswiggins Feb 14, 2015

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

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

@thiagopnts

This comment has been minimized.

Show comment
Hide comment
@thiagopnts

thiagopnts Feb 15, 2015

Member

This would be a great start @chriswiggins

Member

thiagopnts commented Feb 15, 2015

This would be a great start @chriswiggins

@davidaurelio

This comment has been minimized.

Show comment
Hide comment
@davidaurelio

davidaurelio 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.

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

This comment has been minimized.

Show comment
Hide comment
@thiagopnts

thiagopnts Mar 21, 2015

Member

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

Member

thiagopnts commented Mar 21, 2015

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

@bryfry

This comment has been minimized.

Show comment
Hide comment

bryfry commented Mar 29, 2015

+1

@tarkanlar

This comment has been minimized.

Show comment
Hide comment

+1

@snsxn

This comment has been minimized.

Show comment
Hide comment

snsxn commented Apr 2, 2015

+1

@deedos

This comment has been minimized.

Show comment
Hide comment

deedos commented Apr 10, 2015

+1

@irongomme

This comment has been minimized.

Show comment
Hide comment

+1

@thiagopnts

This comment has been minimized.

Show comment
Hide comment
@thiagopnts

thiagopnts Apr 13, 2015

Member

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

Member

thiagopnts commented Apr 13, 2015

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

@leandromoreira

This comment has been minimized.

Show comment
Hide comment
@leandromoreira

leandromoreira Jul 24, 2015

Member

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

it's almost one year old 🎂

Member

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

This comment has been minimized.

Show comment
Hide comment
@leandromoreira

leandromoreira Aug 22, 2015

Member

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 ?

Member

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

This comment has been minimized.

Show comment
Hide comment
@towerz

towerz Aug 22, 2015

Member

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.

Member

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

This comment has been minimized.

Show comment
Hide comment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment