3 ms·
You need a better layout for your API documentation. It's a wall of text. Add in a navigation sidebar, or better yet just copy Stripe. Also the how-tos are too
by alextgordon 11y ago
You need a better layout for your API documentation. It's a wall of text. Add in a navigation sidebar, or better yet just copy Stripe.
Also the how-tos are too longwinded. You could probably reduce the quantity of prose by 50% or more. e.g. the very first paragraph "Getting logged in is easy and takes only a second..." is waffle and missing a vital opportunity to explain how the damn thing works!
- jamiesonbecker 11y agoAlex thx -- this is great feedback. We'll get these cleaned up!
- wise_young_man 11y agoThere's an open source project called Slate [1] which is basically a static site generator for API docs you might consider which looks like Stripe's API docs. [1]: https://github.com/tripit/slate https://github.com/tripit/slate