Make the README into API docs

Question

Make the README into API docs

gnarf opened this issue 11 years ago · 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.

Raphael Amorim · Answer 1 · Sat Jun 25 2016 06:38:21 GMT+0800 (China Standard Time)

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

Mx Corey Frang · Answer 2 · Sat Jul 02 2016 04:00:14 GMT+0800 (China Standard Time)

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" notifications@github.com 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
#57 (comment),
or mute the thread
https://github.com/notifications/unsubscribe/AAhh6wDK139jdUmvA4TQ_BQqol4TX2gyks5qPFxegaJpZM4AlYEk
.

Raphael Amorim · Answer 3 · Sat Jul 02 2016 04:08:38 GMT+0800 (China Standard Time)

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

Leo Balter · Answer 4 · Tue May 09 2017 01:16:57 GMT+0800 (China Standard Time)

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

Raphael Amorim · Answer 5 · Fri May 12 2017 07:24:48 GMT+0800 (China Standard Time)

Okay, I'll work on it.