Customer StoriesReadMe Blog
Back to All
added

Owlet Weekly Update (Week of August 16)

August 17th, 2021

It's that time of the week again, folks! You know that fancy form in the API reference section? The one where you can enter parameter values when constructing an API request? Well as you may know by now, we massively redesigned it in the last few months to include better support for example parameters, nested objects, and lots of other good stuff. Well the good stuff continues with this release—fancy tooltip schema validation, user-specific parameter defaults, and much more. Details below! 🥭

👍

We've been rolling out some new docs designs for a little while now—check out this page for the latest details on what's going on! Changes that are only applicable to the new docs design will be prefixed with a 🆕 emoji.

✨ New & Improved

  • 🆕 You may have seen "fancy tooltip schema validation" mentioned above... but what exactly does that mean? Now, your docs will determine the schema for each form field based on your API specification and provide instant visual feedback to the user as they enter data to make sure they're adhering to your data requirements. Oh, and did we mention that this is all in fancy tooltip form? Not to toot our own horn, but our docs are a great way to see this in action. ✅
  • 🆕 Now let's be honest—adding parameter defaults in your docs can be great! Saves a potential click and provides helpful context for your users. But sometimes a one-size-fits-all approach isn't good enough. Well as of this release, you can take that personalized documentation experience to the next level and pass in parameter defaults via the user data payload. Check out our docs for the details. 📛
  • 🆕 Subtle design and animation improvements to certain buttons and dropdowns throughout the product. 🎨

🛠 Fixes & Updates

  • 🆕 This release includes several improvements to the sidebar, primarily with respect to accessibility! Now it's easier to navigate the sidebar via a keyboard, with better support for parent/child page toggling and better visual cues. It also includes several small stability improvements for a select few pages so selecting a link from the sidebar actually takes you to the right place. 🧭
  • Now here's a cute ReadMe fact: when you submit a Suggested Edit and the project administrators approve it, you get an email commemorating your generous contribution of knowledge! But the celebration was occasionally ruined when the link to the updated page would lead to the wrong page. This release includes a fix that should keep the party going. 🥳
  • 🆕 Light text on a dark background? Great. Dark text on a light background? Love it. Light text on a light background? Yikes. For users on certain mobile devices, this release addresses the last category for certain navigational dropdowns. 📱
  • 🆕 This release makes it so the API Reference section does a better job of displaying HTTP codes when a user clicks the trusty "Try It" button for certain API configurations. 🟢
  • Fixed an issue where certain project admins were unable to directly save edits via the Suggested Edits view. 💾
  • Fixed an issue where a select few unlucky users were unable to easily navigate back or forward in the dashboard. 🔙
  • Fixed a couple of edge cases when re-saving API definitions via the manual API editor. 🔄
  • 🆕 Minor stability improvements for response examples. 🐴

As always, thanks for reading and for being a part of the ReadMe community!

—Kanad and the ReadMe Team :owlbert:

📘

What is the Owlet Weekly Update?

Thanks for tuning in to another edition of our Owlet Weekly Update—an owlet-sized update (posted every week to the ReadMe Changelog) on the product updates we're shipping here at ReadMe. We'd love to hear what you think of these updates at [email protected]!