What are the best dev docs you've read? And why?

Question

I enjoyed reading docs from Algolia and Stripe, both are educative and visually stunning. What dev docs recently WOW you the most?

Emily Melhuish · Accepted Answer

Agree with Stripe! They list what each field means in API and all endpoints plus expected responses and example queries. Additionally their setup and dev kit docs are up to date with working examples in all of the common languages. We found it super quick to integrate with it.

I think for docs, it's key to be both succinct but state every detail. I find it frustrating when docs are out of date and the examples don't actually work.

Rosie Higgins · Answer

@fmerian I mean features of the library, such as classes that are not listed.

Rosie Higgins · Answer

@fmerian or explanations for what particular functions/methods do. This happens with Babylon so we often have to guess or look at the source code

Rosie Higgins · Answer

Material UI is one of the best I've used recently, they have easy navigation, loads of great demos and examples with lots of variation, and thorough API documentation.

On the other end of the spectrum some bad ones I've experienced are the Blender API docs and the BabylonJs docs. Difficult to navigate and some fundamental stuff missing meaning you often have to delve into the source code or rely on a forum post to find what you need.

flo merian · Answer

@kanocarra WOW, Emily, I absolutely love your feedback. Thank you so much!

Sam Sanchez · Answer

Golang, efficace et claire

flo merian · Answer

@rosie_higgins_grapevine Hi Rosie, thanks for your reply!

Material-UI is a great one indeed. What are the fundamental stuff you're refering to? Demos? Examples?

What are the best dev docs you've read? And why?

Replies