fixed

Owlet Weekly Update (Week of June 14)

It's about that time, folks! This week we're providing you with marginally more insight about our rollout timeline and shipping Enterprise authentication fixes, making search indexing faster, and lots more. Details below! 🚀

Sorry for sounding like a broken record here—but you may be aware that we've been working on a new docs design and architecture for quite some time now! This week contained lots of improvements on that front, including (but not limited to):

  • A new design for embedded Recipes with better support for embedding in the API Reference section. 👩🏽‍🍳
  • Various UX improvements (including a new table of contents!) in the reference section. 🎨

We'll be kicking off our rollout to current customers very soon (more details to come!), but if you want to get a head start (or at least get a preview of the changes in your docs), drop us a line at [email protected]! ✨

Now, for your current, much-more-mediocre-but-nevertheless-extremely-good documentation experience...

  • If you've ever gotten irrationally upset because you were this close to submitting a valid ReadMe two-factor code, but missed the mark by literally a split second and you have to pull out your authenticator app AGAIN and... *immediately cuts to disclaimer from our security team* "Two-factor authentication (2FA) adds an important additional layer of security to your account. Despite Kanad's endless rant about seemingly nothing, we strongly recommend you enable it. Please see our docs for more info." *cuts back to Kanad, still yelling* Anyways, regardless of your feelings on the matter, I'm happy to announce that this release extends the 2FA window by a few precious seconds. 🔑
  • We're shipping lots of little fixes to Enterprise authentication workflows! This release addresses several quirks around SAML and JWT and includes better handling for users with ReadMe logins that are logging in via a Custom Login method. 🔒
  • Huge performance improvements to search indexing—meaning that changes to your documentation will show up in your users' search results even faster! 🔍
  • Fixed a tiny bug in our cURL snippets where certain brackets weren't being properly escaped. 🥌
  • Better handling of certain YAML files. 🍠*

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

* Not to toot my own horn, but I'm extremely proud of this emoji usage.