Hacker News new | ask | show | jobs
by hughjeremy 2897 days ago
Thanks fiatjaf! The documentation definitely needs work. And worse, it only documents HTTP interactions, not the rapidly expanding client libraries! Do you have any examples of documentation you really like? I'm a big fan of Stripe's but I'm not sure if I can replicate that level of quality quickly.
1 comments

Ok, actually I don't think the documentation needs to be improved a lot, I think you can get 1000% better if you add a "quick start" guide for developers. Just a small page with examples so they get the feel of it. Then they can consult the full reference if they need do to anything else.

For example, https://strike.acinq.co/documentation/get-started and https://developers.trello.com/docs/api-introduction

Nice, thank you so much for those examples, fiatjaf! I actually already had a 'getting started' page (https://amatino.io/articles/getting-started) but it is nowhere near as good as those ones you've linked. Plus it obviously is not easy enough to discover! I'll review those examples and try to lift Amatino up to their standards.

PS - Strike's page is so nice! Hnnnggg. Love the little diagram.