search

pixelpost / ultralite2

The second generation core framework for Pixelpost v2.
15 stars 0 forks source link

Include Working Examples in API Docs #3

Open jaywilliams opened 12 years ago

jaywilliams commented 12 years ago

I'm thinking it might be handy to include working jQuery and even possibly command line cURL examples in the API docs.

Eventually, it would be handy to setup a live demo photoblog with some test keys to allow people to play around with the API.

What do you think?

Seza commented 12 years ago

I didn't see any objection to that, that's a good idea and could help lot of users who want to play with the API.

I think the priority is documentation, api documentation and a developer's guide which certainly will a good place to jQuery / cURL and API interactions example. After, why not add a live demo or a sandbox for developers in support.

jaywilliams commented 12 years ago

I think providing a sandbox would be a wonderful help. As far as the JS is concerned, we could easily use a site such as http://jsfiddle.net/ to power live, working demos. We could throw the sandbox on a free, isolated VM over on Pagodabox, so there wouldn't be any worries about potential security breaches.

Seza commented 12 years ago

That fells great, you seem have some knowledge on this subject I haven't. So If you want to take the hand on that there is no problem for me.

Le 19 juin 2012 à 16:25, Jay Williams a écrit :

I think providing a sandbox would be a wonderful help. As far as the JS is concerned, we could easily use a site such as http://jsfiddle.net/ to power live, working demos. We could throw the sandbox on a free, isolated VM over on Pagodabox, so there wouldn't be any worries about potential security breaches.

Reply to this email directly or view it on GitHub: https://github.com/pixelpost/ultralite2/issues/3#issuecomment-6426207

Alban LEROUX seza@paradoxal.org

jaywilliams commented 12 years ago

Ok, I'll assign myself to the task.