Let's say you get back an error. We've made it so the API creator can link in the response to a unique page in the docs, where they'll see their actual API log. They can see exactly what the server saw and returned, replay the request, and more. If an error code is returned, the API creator can write out what the error means and how to fix it.
If that's not enough, they can open a support ticket on ReadMe, and include the logs that seem broken. That way, both sides are looking at the same API logs, and know things like what SDK is being used or if the data is URL encoded properly.
Lastly, we're going to build tools that are more proactive. Like, if a customer is getting a certain threshold of errors in production, we'll make it easy to trigger an email to them with a warning.
Engineers, support, solutions engineer, dev evangelist, content writer (with a technical background), and more! If you don't see the right job, email greg@readme.io!
Hey Greg! I don’t know if you remember, but one time we got I think third place at an RIT hackathon.
It was really cool to find out that you were the founder of readme after hearing about it (and asking for the budget to buy it). Congratulations on the Series A!!
We think we used that URL when we submitted to HN a few years ago because the root domain had already been submitted: https://news.ycombinator.com/item?id=6397526 (I ended up offering to pay for it!)