Inspiration

[0x-r4bbit]

Maintaining a list of existing documentations here as inspiration. Feel free to add links to the list!

[0x-r4bbit]

Landing Page

• Dart - https://www.dartlang.org/
• AngularDart - https://angulardart.org/
• Polymer - http://www.polymer-project.org/ <3 it

API Docs

• EmberJS API - http://emberjs.com/api/
• Phonegap - http://docs.phonegap.com/en/3.4.0/ (version select)
• Vue.js - http://vuejs.org/api/index.html
• Sphere - http://commercetools.de/dev/ (nice search)
• jQuery - http://api.jquery.com/ (good examples)
• Contentful - https://www.contentful.com/developers/documentation/content-delivery-api/ (makes use of console in browser)
• Stripe - https://stripe.com/docs/api

Developer Guide

• EmberJS Guide - http://emberjs.com/guides/
• Ionic - http://ionicframework.com/docs/
• Phonegap - http://docs.phonegap.com/en/3.4.0/
• Polymer - http://www.polymer-project.org/docs/polymer/polymer.html
• Vue.js - http://vuejs.org/guide/
• Laravel - http://laravel.com/docs

General Feedback

I also asked in the dev community in generell what they really like and what makes good online docs for them. Here are some points that came up:

• Illustrations for concepts, abstract architecture etc.
  • example: angular scopes http://docs.angularjs.org/guide/scope#scope-hierarchies

[snoopyart]

May be http://commercetools.de/dev/ is also worth a look - quite good search in focus

[0x-r4bbit]

Very good one! Updated the list accordingly.

[boennemann]

I really love the contentful approach of exposing the client library to the console so you can already play with the API while reading the docs. (@ehd)

Definitely worth a look if it fits your use case.

[0x-r4bbit]

@boennemann Wow that's cool! I'm sure @pxlpnk told me about it and I've just forgotten it. Anyway, neat feature indeed!

[janpantel]

I love the way the laravel framework is documented. Check this out: www.laravel.com

[0x-r4bbit]

Hey @Kyjan thanks for sharing! I don't like the API docs, but the guide seems to be neat. Added to the list.

[seidtgeist]

When deciding on the documentation definitely keep in mind how you're going to maintain it:

It should be simple and safe to change and expand the documentation. I suggest running code samples against tests so you have an automated way of checking that everything still works the way you tell others (a) after updating the documentation and (b) after changing the libraries/APIs you're documenting.

Another great API documentation: https://stripe.com/docs/api

[0x-r4bbit]

Thanks @ehd for leaving your thoughts here! So yea, we plan to add unit- and e2e-tested for baked in examples anyway. As a user, you should get the best possible experience when reading the docs of the sofa project. This includes a documentation that doesn't leave any questions open, but also interactive demos with which you can play while reading them.

Adding stripes API to the list, thanks!