Owlet Weekly Update (Week of August 2)

Hello and happy August, m8s! Get it? Because we're officially in August? And August is the 8th month of the year? And then the -ate of mate sounds like the number 8? Did you get the joke? I thought it was pretty funny. Anyw8, hope you didn't have to w8 too long for our weekly upd8! We have a large pl8 of exciting stuff for you this week, from support for readOnly and writeOnly examples to performance improvements across the board—read on to find out more! 🎱

👍

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

• 🆕 Like folks waiting for Kanye West's upcoming album, we've been eagerly anticipating the release of a new feature in the API Reference section that adds support for readOnly in response examples and writeOnly in request examples. Unlike folks waiting for Donda, this feature actually released on time. #illbelieveitwheniseeit 💽
• 🆕 This release includes design improvements in the API Reference section to better handle content-less response bodies and to better display the HTTP status code. 🎨
• Support for page views and other behind-the-scenes improvements to documentation metrics. 📊
• This release adds a bit more data to the #hub-me selector for use in your Custom JavaScript. 💾
• 🆕 This release includes faster performance for relative links and links with hash parameters. 🔗

🛠 Fixes & Updates

• 🆕 Like all humans at some point in their lives, the language picker in the API Reference section developed a chaotic complex where it occasionally decided that it didn't want to do its one job (i.e. indicating which language was displayed in the code snippet). It knew in its mind that change must occur for growth but in its heart it flourished in this chaos. We had a discussion and it reluctantly agreed that selecting the correct language was best for both itself and our customers. The heart wants what it wants, language picker, the heart wants what it wants. 💔
• 🆕 While we can't promise that your docs will be as stable as Simone Biles during a beam routine, we're happy to report that this release includes stability fixes for landing pages, in-documentation variables, and various form fields in the API Reference section. 🤸‍♀️
• Much like cats on the field during a baseball game, invalid request header formatting can derail an API documentation experience. Thankfully, it's easier to catch invalid header formatting, so this release includes some fixes on that front. ⚾
• This release includes minor improvements to the OpenAPI output of reference docs that are created using the manual editor. Your friendly neighborhood OpenAPI validator will thank you. 🏡
• 🆕 A lot of people h8 when a joke is repeated too many times. Although I've now learned that ReadMe condones the overuse of jokes, we do not appreci8 the repetitive firing of the pageLoad JavaScript event, which we've been seeing when navigating between certain pages. This week's release includes fixes to this pageLoad event, which should result in cleaner Google Analytics and Segment data. 📉

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

—Rahul, Kanad, and the ReadMe Team

(Kanad Aside) Shoutout to our engineering intern Rahul for an amazing summer and for taking the lead on writing this week's Owlet Weekly Update!

📘

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