fixed

Owlet Weekly Update (Week of August 9)

Hello and welcome to another Owlet Weekly Update, friends! In summary (yes, that is in fact a pun), we're bringing lots of little fixes and improvements in the API reference section along with some behind-the-scenes improvements to Documentation Metrics. 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

  • Behind-the-scenes improvements to Documentation Metricsโ€”in other words, faster loading times when viewing Page Quality in the dashboard! ๐Ÿ“ˆ
  • ๐Ÿ†• As of this release, the summary field now renders for request and response examples! โˆ‘

๐Ÿ›  Fixes & Updates

  • ๐Ÿ†• In previous updates, we've mentioned the massive accessibility gains that come with our new documentation designโ€”one of which is a "Jump to Content" button when tabbing through the page! This release fixes some styling issues that we were seeing for a small subset of project styles. ๐ŸŽจ
  • ๐Ÿ†• Don't you hate to be perceived as something when you're actually something else? While we're unable to address the immense societal expectations that are constantly thrust upon us, this release addresses issues where JSON response examples was being perceived as strings and vice versa. ๐Ÿ”ฎ
  • ๐Ÿ†• This release includes better support for optional OAuth2 securities. And by that, I mean the page will actually load for OpenAPI definitions that utilize them. ๐Ÿ”’
  • ๐Ÿ†• Fixed an issue where setting certain parameter defaults to null would cause rendering issues. ๐Ÿฅด
  • ๐Ÿ†• Addresses several rendering edge cases for schemas that utilize polymorphism. ๐Ÿฅž

Thanks for reading and for being a part of the ReadMe community, folks!

โ€”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]!