search

HubSpot / messenger

Growl-style alerts and messages for your app. #hubspot-open-source
http://github.hubspot.com/messenger/
MIT License
4.02k stars 406 forks source link

Add more traditional API documentation #12

Closed zackbloom closed 10 years ago

rileytg commented 11 years ago

Any thoughts on going about this? Any coffee libs have an API you like?

zackbloom commented 11 years ago

Thanks for commenting @rileytg. We've discussed it over here, and the consensus is that the best documentation is somewhere between Backbone.js (all on one page, easy to ctrl+f) and jQuery (good built-in search, great at showing you what's changed between versions). We can't find an example of a library who's done it perfectly, but if you have any thoughts we're very interested. It's definitely something we're interested in iterating on, maybe in it's own OS project?

kayone commented 11 years ago

I would love some documentation around messenger.js, the samples are great but I find myself guessing about lots of stuff,

even something simple like listing all the options and a short description of what they do would help immensely.

jsodeman commented 11 years ago

Agreed, just a simple list of methods, events, options would be very helpful.

althaus commented 10 years ago

+1 for just a simple list of available options. The examples are nice, but not helpfull for that purpose.

zackbloom commented 10 years ago

http://github.hubspot.com/messenger/

rileytg commented 10 years ago

great success!

On Mon, Nov 25, 2013 at 7:32 PM, Zack Bloom notifications@github.comwrote:

Closed #12 https://github.com/HubSpot/messenger/issues/12.

— Reply to this email directly or view it on GitHubhttps://github.com/HubSpot/messenger/issues/12 .

Riley Guerin (310) 431-6240