improved

Owlet Weekly Update (Week of August 23)

Hello and happy Virgo season, friends! This release includes certain touch-ups with an attention to detail that only a quadruple Virgo could have, as well as several other improvements and fixes that I struggled to tie to Virgo season. More 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

  • πŸ†• This release includes various improvements on the performance and stability fronts for certain API Reference sections. Thanks to a few minor changes to how we handle JSON Schema, certain circular $ref parameters that previously weren't rendering should now render as expected and lots of projects will experience a small performance bump as a result! πŸš€
  • πŸ†• This release includes a major redesign to the API Logs page in the Hub to reflect our new design system and architecture! It's now sleeker and far more performant. ⚑
  • πŸ†• Tweaked the spacing and color contrast on the schema form in the API reference section to help improve readability, particularly for complex schemas. πŸ–ŒοΈ
  • Minor performance improvements when querying page view data from certain places in the dashboard. πŸŽ‘

πŸ›  Fixes & Updates

  • Growing up, you probably heard a gendered variation of the phrase "like parent, like child". As many of us have learned over time (both in life and with respect to documentation architecture in ReadMe), that often isn't the case! But we don't have time to unpack all of that. This release improves the reliability of the workflow of hiding a parent pageβ€”it now properly hides all of its children pages and hides them from your search results. πŸ‘ͺ
  • πŸ†• As you may know, the redesigned reference docs include better support for readOnly and writeOnly parameters and examples. Unfortunately we were seeing an issue where certain readOnly/writeOnly parameters weren't rendering examples if they were located within certain allOf schemas. Thankfully, this release includes a fix that brings them back. πŸ€“
  • Fixed an issue where certain projects weren't counting zero-configuration API Metrics in their total API log counts. πŸ“ˆ
  • πŸ†• Loosened our requirements for valid security schemes. πŸ”

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