p/readme
Beautiful, personalized, interactive developer hubs.
Gregory Koberger
ReadMe Recipes β€” Step-by-step code walkthroughs for your API
Featured
3
β€’
Recipes are a new way to create step-by-step code walkthroughs right in your ReadMe documentation. By helping you showcase the best use cases for your APIs, it's easy for developers to get started faster while saving your team time on developer support.
Replies
Gregory Koberger
Hey everyone! I launched ReadMe on PH a few years ago, so I figured this was a good place to launch our latest feature... Recipes! πŸ‘©πŸΌβ€πŸ³πŸŒ­πŸ”πŸœ Most API documentation focuses on Reference Guides, which have the information you need about an API... all the parameters, endpoints, headers, query params, etc. They're really important! However, for a first-time user (or even someone more experienced), it's like handing someone a dictionary and telling them to learn the language. So, we built Recipes, which are interactive, use case-based code walkthroughs aimed at helping you get your users to solve specific problems. Recipes pair a common use case for your API or technical product with a snippet of code and then walk through the code explaining what everything does. Rather than focus on GETs and PUTs and POSTs, Recipes makes it easy to help your users accomplish the actual tasks they're looking to do. If you already use ReadMe, it comes with your current plan and is ready to use right now! If you don't use ReadMe and your company has an API or other technical product, check us out :) Here's how people are using ReadMe Recipes: https://blog.readme.com/cookin-u... If you wanna chat about this, either post here or email greg at our domain :) Bon appetit! -Greg
Glen Creaser
Awesome! Makes APIs much more accessible and easy :) Congrats
Mateusz ZarΓ³d
Very nice! Is it making something like todo list from api documentation?