jquery-color icon indicating copy to clipboard operation
jquery-color copied to clipboard

Make the README into API docs

Open gnarf opened this issue 11 years ago • 5 comments

I asked @kswedberg in IRC today to take a look at the readme here and help me add some prose/better documentation for these signatures. Currently it is pretty hard to actually learn about everything color can do since the language in the readme isn't very easy.

gnarf avatar Apr 17 '13 06:04 gnarf

@gnarf can I proceed with this issue? What do you think about create a api.jquerycolor.com using jquery-wp-content?

raphamorim avatar Jun 24 '16 22:06 raphamorim

I feel like this might be overkill... the API is pretty tiny, but we need better documentation and examples... maybe a jsdoc generated gh-pages branch? On Jun 24, 2016 18:38, "Raphael Amorim" [email protected] wrote:

@gnarf https://github.com/gnarf can I proceed with this issue? What do you think about create a api.jquerycolor.com using jquery-wp-content https://github.com/jquery/jquery-wp-content?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/jquery/jquery-color/issues/57#issuecomment-228479949, or mute the thread https://github.com/notifications/unsubscribe/AAhh6wDK139jdUmvA4TQ_BQqol4TX2gyks5qPFxegaJpZM4AlYEk .

gnarf avatar Jul 01 '16 20:07 gnarf

For me okay, Could you create a gh-page branch on repo? (I don't have permissions to do that hehe)

raphamorim avatar Jul 01 '16 20:07 raphamorim

@raphamorim you can use a /docs folder in the master branch to publish the api as a gh-pages. This is the same approach we're using for QUnit. It's good as it publishes the api docs in sync with the current master version.

leobalter avatar May 08 '17 17:05 leobalter

Okay, I'll work on it.

raphamorim avatar May 11 '17 23:05 raphamorim