Hello and happy Leo season, friends! We come to you in this bold season of the Lion with bold upgrades to rdme and the Python Metrics SDKs, progress on our rollout of bold docs redesigns, and... a bunch of relatively small design tweaks and bug fixes across the board (that are nevertheless bold in spirit!). Details below! 🦁

📘Slight Delay In Publishing

This post is backdated to July 21st around 11:40am PDT, which is when this release went live. This post was published on July 23rd. Thanks for your patience, folks!

As mentioned above, our rollout of our new docs designs continues! You should be able to see a little message in your project dashboard that contains a link to preview the changes and a button to upgrade. We can't wait to see your upgraded docs! 🚀

👍

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

• 🆕 We've made a small adjustment to how our bundles (i.e. the general JavaScript and CSS assets that are included as part of your ReadMe docs experience ✨) are being served to better take advantage of our shared CDN—this will allow for better caching and zippier loading of your assets! 🍑
• We recently shipped enormous improvements to our Python SDK for API Metrics! The SDK now includes functions that are specific to Django and Flask, which should make them easier to integrate and far more stable. 🐍
• We also recently shipped v4 of rdme, AKA the official ReadMe CLI! Lots of improvements were included in this release including pre-upload OpenAPI file validation, smarter syncing of Markdown docs, and fewer bewildering error messages. And perhaps most importantly, it includes a new Owlbert!
• 🆕 Here at ReadMe, we firmly believe that all table columns are created equal. But from time to time, we need to reckon with the fact that certain table columns require more space than others. This release makes it so table columns are more intelligently sized based on content. 🏓
• 🆕 The API Reference now supports readOnly parameters in response schemas and writeOnly parameters in request schemas. ✍️

🛠 Fixes & Updates

• 🆕 Being able to see your API request history in the new docs is great, but you know what's even better? Being able to see all of your available API request history. This release includes a fix where certain users were unable to paginate through their request history. 📜
• 🆕 Before this release, you could try and load a Custom Page written in HTML and 50% of the time, it would load 100% of the time. This release makes it so 100% of the time, your HTML-based custom pages load 100% of the time. 💯
• 🆕 This fix brings back the copy-to-clipboard buttons for certain Markdown code samples in the reference section. We've missed you, old friend. 📋
• 🆕 As of this release, we do a far better job of adhering to the link color you specify in the Theme Editor. 🌈
• 🆕 Fixed an issue where links to search results for certain projects were broken. 🔗
• 🆕 Design tweaks to better handle long response schema titles. 🤥
• 🆕 Fixed a couple of edge cases for SSO login flows flows. 🔐

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

📘Delayed Release Notes

This tiny patch release went out on July 12th around ~12pm PDT, but the release notes were retroactively published on July 21st. Apologies for the delay in publishing folks!

Hello and welcome to another super tiny weekly update! We're spending the week at our offsite at Camp ReadMe (adorable team pictures and Owlbert graphics to follow!) so we didn't publish a full release. The only thing that went out this week was a tiny Custom OAuth Login redirect fix.

Thanks for reading this super short update 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! This week's release is slightly smaller but no less mighty. We're bringing you various bug fixes and improvements to keep up our rollout momentum. Read all the 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

• 🆕 Good news for folks who want a little more interactivity in their lives! The path parameters in URLs at the top of API Reference pages are now clickable, and will direct you to the appropriate form input for that field.

🛠 Fixes & Updates

• 🆕 Folks who were feeling shy about their reference changes and wanted to hide specific pages but still share them with certain people weren't able to. This release includes a fix that allows folks to share direct links to hidden reference pages so all your closest friends can see them.
• 🆕 UI improvements to the Changelog page. See if you can spot them on this page!
• 🆕 Some fixes for Suggested Edits to make sure users of all types of customers' docs are able to get their voice heard!
• 🆕 Straightening out some quirkiness with response docs to ensure you can always view your properties!
• 🆕 Fixing an issue with redirecting hashed URLs, ensuring that you'll always receive the correct page content even if you're coming from a URL in the old format!

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

—Naomi 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! This week we're shipping Simple Mode and support for response headers in the new reference designs, and we're continuing the momentum of our rollout! Get the details below! 📚

👍

Now if you're living under a rock and haven't heard about the new docs designs we've been rolling out—check out this page to see all of the exciting changes coming your way! Changes that are only applicable to the new docs design will be prefixed with a 🆕emoji.

✨ New & Improved

• 🆕 With this release, we're rolling out Simple Mode™ (disclaimer from our legal team: Simple Mode is not actually trademarked, Kanad is just trying to make it sound fancy)—an SDK powered by ReadMe's api package alongside a new API registry (which handles automatic versioning as your API and your API documentation evolves). What exactly does this mean for your users? Far more digestible and readable code samples, resulting in a faster time-to-first-call! 🚀
• 🆕 The ability to search for endpoints in the endpoint quick navigation by HTTP method. 🔍
• 🆕 A newly designed modal for displaying response headers in "Try It!" requests. 🧄

🛠 Fixes & Updates

• Fixed an issue where, in certain cases, logging in to the hub would not properly redirect to the page you were previously on. 🔁
• Tiny fixes to code editors in the dashboard to make them easier to... edit code in. 📓
• 🆕 Several UI improvements in the request history table. 🎨
• 🆕 Various OpenAPI edge case improvements. 🚧
• 🆕 Bringing back the Intercom integration. 💬

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

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