Owlet Weekly Update (Week of December 7)

Thanks for tuning into another Owlet Weekly Update! This week we're improving dashboard loading times 🚀, shipping zero-config(!) API Metrics 🌱, paying homage to a (scarily relevant) synth-pop music video from the mid-2000s 🎹, and so much more. Let's dive in!

✨ New & Improved

• In most aspects of life, you reap what you sow. There’s no greater example of that than our API Metrics platform—if you take a little bit of time to plant the seeds (the API Metrics proxy or middleware), they will yield a bountiful harvest (a greater understanding of your API users). Well what if you could reap (in a good way!) without doing any sowing? That’s right folks… we’re officially launching Zero-Configuration API Metrics! We’ll have more to say about this soon, but the long story short is that all interactions with your API reference section will now produce API Metrics usage data, meaning that you now get a preview of the insights that API Metrics has to offer with zero setup or configuration! If you like what you see and you decide that you want these insights for every user that interacts with your API, you’re always welcome to plant a few seeds. 🌱
• Great news folks—we now support 3OH!3! Whoops sorry—what is this, the mid-2000s? What I meant to say is that we now support Version 3.0.3 of the OpenAPI specification! And not only that—going forward, all API definitions that are written in our manual editor are now compiled into 3.0.3! The only downside of all of this is that it’s very unlikely that I’ll be able to drop such a topical reference for future versions of the OpenAPI spec. 🎹
• As we continue to build out our OpenAPI support in the API Explorer, it sometimes takes a bit longer to extend certain things to our dear manual API editor users. Well I've good news for y’all: we just added enum support to our manual editor, meaning that reference sections of all creeds can now have their users select parameters from a dropdown list of values! ✅
• Sometimes when loading up a project in the ReadMe dashboard, you may be like me and occasionally use that generous chunk of time to refill your coffee cup, do some laundry, or walk the dog. Well I’m afraid you’re going to adjust your schedule… because we’ve made some significant improvements to our dashboard loading times! 🚀
• This release lays some of the groundwork for upcoming performance improvements to the API Explorer, particularly for you crazy kids out there with massive API definitions. Stay tuned! 🚄
• A few more small improvements to an extremely exciting upcoming ReadMe feature that we have a lot more to say about soon! 🧑‍🍳

🛠 Fixes & Updates

• Much like most of us during quarantine, there were a few specific cases where documentation sidebar links were having trouble staying active. While we can’t afford to give everybody a Pelaton in this release, it does fix the styling on these sidebar links. 👟
• Huge developments in the society’s conversation around callout culture: we were seeing an issue where certain Markdown callouts were missing their body text. Fortunately (or maybe unfortunately, depending on your feelings about callout culture), we’ve restored the body text of these callouts. 🗣️
• A few content width improvements for folks that like to live dangerously (i.e. people that look at API documentation on their phone). 📱
• We added scrollbars to a couple places that needed them, and hid them in places where you didn’t need to see them. 👀
• A handful of little reliability improvements to our code blocks. 🧱
• Tiny improvements to how we bundle OpenAPI documents. 📦
• A few reliability improvements to our PDF generation. 🖨️

Thanks again 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 Tuesday to the ReadMe Changelog) where we provide an overview of the product updates that went out as part of our new Tuesday release cycle. As we refine our format and process for providing these updates, we'd love to hear what you think at [email protected]!