Owlet Weekly Update (Week of July 26)

Hello and happy Tuesday, folks! We spent the larger chunk of last week in a hackathon where lots of incredible work was done—much of which you'll see in this release! Major accessibility gains, new metrics sharing workflows, design improvements, and so 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 know that sinking feeling when you're on an infinitely long road with seemingly no end in sight? While, in a twisted sense, that could be a metaphor for life itself, that's also a metaphor for paginating through our API results. While our response headers provided helpful information about accessing what's immediately in front of you and what's immediately behind you, there wasn't much information on accessing the destination... until today! As of this release, we've extended our existing Link response header and added a new x-total-count header which should hopefully alleviate that sinking feeling. Check out our pagination docs for more info! 🛣
• 🆕 As alluded to above, last week's hackathon yielded massive accessibility improvements across almost every aspect of the hub! Most of the changes are almost completely invisible in nature, but this release includes many contrast improvements and subtle changes to the markup to make pages easier to tab through and friendlier for screen readers. More to come on this front! 🎉
• 🆕 We've made some performance improvements (as well as some tiny design improvements) to landing pages! They should be zippier during initial render and when navigating between other sections of your docs. 🏡
• 🆕 This release includes a fancy new toggle in the API Reference section that makes it easy to securely share individual API logs with others, as well as some other small metrics UI improvements. 🤝

🛠 Fixes & Updates

• 🆕 Fixed an issue where links to API Reference pages that contained hash parameters were inadvertently redirecting. This was due to a false positive with some redirect logic we have in place to handle redirects from pages in the legacy reference section design to the newly redesigned reference section. Check out our migration guide for more information on ensuring your legacy links continue to work as expected! ⛓️
• The login button was having a bit of trouble reading the room in very specific cases—in other words, showing up when it wasn't supposed to, and not appearing when it should. Thankfully, we've given it a bit of a pep talk and it should be appearing as expected. 🔐
• 🆕 This release fixes an issue with our Markdown parser where it was basically impossible to write links that open in a new tab (like this one!). All you need is a standard HTML <a> tag with a target="_blank" attribute. 🔗
• 🆕 If you're reading this on your phone, you're probably aware of this already... but this release includes responsiveness improvements in the Changelog! 📱
• 🆕 Stability improvements for navigation between certain pages. 🧭
• 🆕 Minor tweaks to robots.txt. 🤖

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

—Kanad and the ReadMe Team

📘

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]!