Welcome to another Owlet Weekly Update, folks! Several of y'all are boarding the new reference docs hype train and Cancer szn is upon us, so needless to say... we're deep in our feels. We attempt to unpack all of this below! 🚂

As many of you will start to see in your dashboards, we're ramping up our migration onto the new and improved docs design that I refuse to shut up about. We've written an FAQ that provides background on the aforementioned hype train (with a subsequent clarification that it is not just a "hype" train but in fact a train filled with substantial improvements to your users' documentation experience). (toot toot!)

This release continues the momentum of this train and brings lots of polish for various OpenAPI edge cases, restores the Health Check feature, re-indents your Table of Contents, and other little fixes and design tweaks. And good news for all of our Safari 13 users—we've made the sidebar legible again (our deepest apologies to all four of you).

Now as you may know, the arrival of Cancer szn also coincides with Juneteenth and Pride Month. Here at ReadMe, we've been having a lot of important conversations about these powerful and ongoing movements for Black and LGBTQ+ lives. We've been reading these pieces on the origins of Pride and the history of Juneteenth. And we're donating to several groups that are doing the important work of supporting Black trans folks—please join us!

• Trans Justice Funding Project (a community-led funding initiative focused on supporting trans justice groups that makes annual grants with the support of trans justice activists)
• Black Trans Femmes in the Arts (resources to Black trans artists; this particular demographic has been really hard hit during COVID-19)
• Marsha P. Johnson Institute (founded in the name of the Black trans woman who was one of the people behind the Stonewall Riots)
• Princess Janae Place (supports trans and gender non-binary and non-conforming folks experiencing housing insecurity in NY state)
• The Okra Project (focuses on feeding Black trans people)
• Trans Lifeline (provides trans peer support in the form of a grassroots hotline and microgrants to folks in crisis)

Enormous shoutouts to the Black and queer folks at ReadMe that put these resources together. Happy Pride and Happy Juneteenth, folks!

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

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

📘

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.

Hello and welcome to yet another weekly update! We've been writing these for a year now and I am feeling some type of way about it, so you bet that there will be some reflections on this milestone (in addition to our regularly scheduled programming, of course). More below! 🥳

If you've been following along lately, you'll know by now that we've been working on a new docs design and architecture for quite some time now! This week contained even more changes on that front:

• Improved handling of request examples for reference documentation written using our manual editor. 🥡
• Small design and performance improvements across the board, namely on the routing, suggested edits and API Metrics fronts. 🔗

We'll be rolling out these changes pretty soon (more details to come), but for now you can always check out our docs to get an idea of what these changes might look like for your docs. And as always—if you want to get in on the fun (or at least dip your toes in the water), drop us a line at [email protected]! ✨

As for your current, much-worse-but-nevertheless-quite-good documentation experience, we're shipping out new options for customizing the top navigation bar for Enterprise Global Landing Pages. 🌎

As mentioned above—as of this week, we've been writing these Owlet Weekly Updates for a year now! While our focus has always been to provide you with transparency and information on our product releases, we've also remained deeply committed to staying weird and culturally relevant. Additionally, it's been a much-needed form of escapism during a very difficult year.

Thanks for bearing with us as these updates have referenced everything from the Fast and Furious Cinematic Universe (F9, in theaters soon) to the Paddington Cinematic Universe and literally everything in between and outside of that spectrum. And as always, thanks 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 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]!

Hello and welcome to another Owlet Weekly Update, friends! This release was on the smaller side due to lots of folks being out over the extended holiday weekend. More (but not much more) below!

This week we're shipping a few design tweaks and improvements to the aforementioned new docs design and architecture. Specifically...

• Design improvements to the parameter fields and response schema modals. 🎨
• Small design tweaks to our server URL and authentication UI. 🔗
• Improved API Metrics integration with the reference section. 📊

As you're probably aware, these changes aren't hitting a docs site near you anytime in the immediate future, but you can check out our docs for an idea of what these changes look like. And as always—if you want to get in on the fun, drop us a line at [email protected]! ✨

Not a ton of changes to most current docs in this release—only thing worth calling out is that we made some HTML sanitization tweaks for Custom HTML on Landing Pages.

Thanks for tuning into this short and abnormally formatted update, folks!

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

Hello and happy Tuesday, folks! We're still shipping lots of polish and improvements to our forthcoming designs—this week included redesigned page voting thumbs and page footers, among lots of other things. If you'd like to be a part of our beta program or even just to get an idea of how these updates can improve your documentation experience, be sure to drop a line at [email protected]! As for your current, somewhat-worse-but-nevertheless-very-good documentation experience, we're shipping API Metrics improvements and blasting Olivia Rodrigo. Details below! 😛

✨ New & Improved

• As part of the API Metrics infrastructure upgrades we mentioned last week, we're rolling out our Clickhouse infrastructure into several more places! The API Metrics Dashboard and the API request history in the reference section should both be much snappier. 📈

🛠 Fixes & Updates

• If you're like me and most millennials over the last week or so, you're probably naming your API versions something along the lines of v1-cause-you-said-forever-now-i-drive-alone-past-your-street. Well good news for people like us—this release includes a few fixes to better handle of long version titles. 🔰
• Great news for fans of hosting large groups of people for dinner and/or succinctly conveying lots of information in a structured manner—this release includes some styling tweaks to better handle overflow on long tables. 🧀
• A couple of small path validation improvements to the Enterprise parent-child routing features that we rolled out a few weeks ago. 👪

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

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

Hello and welcome to another Owlet Weekly Update, y'all! Gemini season is around the corner and the energy is absolutely overwhelming for all of us here at ReadMe—not only because we have lots of birthdays coming up, but because we're also kicking off the beta period of our new designs*! But the fun doesn't stop there—we're also shipping several performance and design-related updates. Details on everything below! ♊

✨ New & Improved

• As mentioned above, we're entering the first phase of our beta period for our new documentation design! You may have already noticed the new digs on our site for several weeks now—but starting today, all newly created ReadMe projects will feature the new design! And these improvements aren't just cosmetic y'all—this is a complete rewrite of our web application from the ground up that gives your users a faster, lighter, and more secure experience when using your docs. Oh, and did I mention that it's far more mobile-friendly? We'll have lots more to say soon, but if you're interested in joining the beta program, contact us at [email protected]! 🆕🎊🦉
• We've been hard at work at some major infrastructure upgrades for API Metrics (hello Clickhouse!) and the first fruits of this labor are included in this release. The API Metrics Dashboard got a huge performance bump and now loads your API usage information far faster (upwards of a gajillion times, under certain conditions)! 📈
• Rejoice, my cURL-ing crew—we cleaned up our cURL code snippets by way of making JSON data more readable. You can see this behavior in action in our docs—try inserting sample data into the form and observe how the cURL code snippet changes! 🥌

🛠 Fixes & Updates

• This one is for my short screen kings that administer lots of Enterprise child projects: we fixed an issue with our "Manage Projects For Group" modal that made it difficult to view and manage all your projects and screens with smaller heights. This release makes it so you can now navigate through this modal comfortably. 👑
• Good news if you're viewing a discussion forum post and the back button on your web browser is broken for some inexplicable reason—we've added a back button for you! 🔙
• Fixed authentication issues for certain project administrators that were trying (and failing) to make changes to their recipes. 🧑‍🍳

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

—Kanad and the ReadMe Team

* I read this article and the astrologer mentioned that Gemini season means that it's time to "shake off that heaviness", which is exactly what we're doing in terms of our new JavaScript bundle splitting strategy.

📘

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

Another week, another release! We're still hard at work on several huge design and performance improvements (which you can see the fruits of in the documentation you're currently reading!), but in the short-term, this release includes lots of improvements on the Enterprise, mobile, and search fronts. Details below! 🍍

✨ New & Improved

• This release includes a big improvement for Enterprise parent-child routing. You're no longer confined to a project subdomain (which is unique across all of ReadMe—meaning that all of the good subdomains, like kanad, are already taken) and can now specify your own child project paths! Get the details on this in our docs. 👪
• This release includes several improvements on the SAML front—including ADFS support! 🔐

🛠 Fixes & Updates

• The Enterprise Staging dashboard would error out and load a blank page under certain circumstances. Under other circumstances, projects with the staging feature enabled weren't routing to the correct place. This release frees us of all of these circumstances! 📟
• For those of you that scroll through API reference documentation on your phone, this release includes some fixes for mobile navigation so your experience is less of a doom-scroll and more of a... joy-scroll. 📜
• Increased the spinniness of our certain compass icons in the Enterprise dashboard by... infinity! Also other small style tweaks in the dashboard. 🧭
• The search modal no longer shows HTTP methods for search results that aren't endpoints. Hooray for non-misleading search results! 🔍
• Small style fixes in the subheader. 🎨

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

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

Hello and happy Star Wars Day folks! What better way to celebrate such an iconic franchise than with... a huge refresh of our icon set? We're also full-steam ahead on some big polish and design updates to the entire documentation experience (which, again, you can preview in the docs that you're currently reading)! This release also includes some big improvements to audit logs, the ability to select your TLS protocol, and more. Details below! 🌟

✨ New & Improved

• As mentioned above, we gave our icons throughout the product a huge refresh! As Tony, our designer*, puts it: these new icons are simpler, easier to see on smaller screens, and 1000% cuter. Even though this refresh was done as part of our upcoming redesign of our entire product, the new icon set will be rolling out to all existing projects today. Check out the before and after below! 🎨

• Major improvements to audit logs just shipped as part of this release! Going forward, audit logs will contain far more comprehensive information about the content being changed. 📝
• This release includes the ability to specify the TLS protocol for your site. Networking protocol nerds—this one's for you! 🌐
• Improved sidebar scroll offset configuration—see your Custom JavaScript settings in the dashboard for more info. 📜
• Improved guidance in the dashboard for single Enterprise projects, which we shipped last week! 👪
• Instant cache invalidation for even more routes. 🌤️

🛠 Fixes & Updates

• Certain code blocks in the API Reference were missing copy-to-clipboard buttons—thankfully, this release brings those back! 📋
• Small CSS class tweaks on project landing pages. 💄

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

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

*We need more of you, come work with us!

Hello and happy Tuesday! We're still adding prolific amounts of polish to our newly redesigned site navigation and API Reference section (which you can preview in the docs you're reading in this exact moment!), but that didn't stop us from shipping lots of improvements for our Enterprise customers and for the existing API Reference. Details below! 💄

✨ New & Improved

• This release includes a big improvement to how we render response examples in the API Reference—particularly if you're having writer's block! If you don't have the time nor willpower to document a response example (we get it, times are tough), we'll fluff out the response section of your docs with some helpful info on the HTTP response code. Check out an example here! ℹ️
• Good news for fans of Enterprise projects and/or family—this release includes a couple big improvements to the Enterprise parent/child projects! Enterprise projects with a single child can now automatically redirect without the need for a child subdomain in the URL (get in touch with your CSM to set this up!), and you can now edit the subdomain for parent projects. 👪
• As much as we believe that your experience in ReadMe documentation is enhanced when you're logged in, sometimes it might be nice to... you know... have the ability to log out. Thankfully, we've made it easier for projects with custom identity providers to configure a URL for logging out. 🔐
• We're taking Global Landing Page personalization to a whole new level—you now have access to the current logged-in user's name via the Liquid template variables! 🌍
• With the coming of the Spring and Taurus seasons, the winds of change are all too palpable. It is in this spirit that you can now rotate out your project API key. 🌬️

🛠 Fixes & Updates

• You'll be happy to hear this, particularly if your dad invented Toaster Strudel: we shipped a lot of small improvements to our JavaScript Fetch and node-fetch code snippets. Better handling of URL-encoded body payloads, query string parameters, and response bodies. You go, Glen Coco! 💁‍♀️
• Search indexing fixes for Enterprise projects using a staging environment. 🔍
• Minor fixes to the SAML Authentication workflow. 👥

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

—Kanad and the ReadMe Team

P.S. We're hiring! We'd love to work with you, particularly if your current employer goes public with policies that don't exactly prioritize your well-being 🤝

📘

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

Hello and welcome to another weekly update! We remain focused on some big, internal changes to our reference section, following our preview release on our own docs last week. This release brings a bit of polish on that front, as well as some under the hood touch ups. We also shipped some big Single Sign-On (SSO) upgrades. More below! 🔑

🚧

Delay in Publishing This Update

This post was published on April 27th, but we're back-dating it to April 20th since that's when the changes in this post were released. Apologies for the delay in publishing, folks!

If you're an Enterprise customer here at ReadMe, you know by now that we support a lot of different identity providers. Well as of this release, we officially support multiple identity providers in our SAML integrations for our Enterprise customers! 👥

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

—Rafe and the ReadMe Team

If you're looking for ways to help out with the ongoing situation in the Minneapolis area, please check out these resources.

📘

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