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

📘

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 August, m8s! Get it? Because we're officially in August? And August is the 8th month of the year? And then the -ate of mate sounds like the number 8? Did you get the joke? I thought it was pretty funny. Anyw8, hope you didn't have to w8 too long for our weekly upd8! We have a large pl8 of exciting stuff for you this week, from support for readOnly and writeOnly examples to performance improvements across the board—read on to find out more! 🎱

👍

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

• 🆕 Like folks waiting for Kanye West's upcoming album, we've been eagerly anticipating the release of a new feature in the API Reference section that adds support for readOnly in response examples and writeOnly in request examples. Unlike folks waiting for Donda, this feature actually released on time. #illbelieveitwheniseeit 💽
• 🆕 This release includes design improvements in the API Reference section to better handle content-less response bodies and to better display the HTTP status code. 🎨
• Support for page views and other behind-the-scenes improvements to documentation metrics. 📊
• This release adds a bit more data to the #hub-me selector for use in your Custom JavaScript. 💾
• 🆕 This release includes faster performance for relative links and links with hash parameters. 🔗

🛠 Fixes & Updates

• 🆕 Like all humans at some point in their lives, the language picker in the API Reference section developed a chaotic complex where it occasionally decided that it didn't want to do its one job (i.e. indicating which language was displayed in the code snippet). It knew in its mind that change must occur for growth but in its heart it flourished in this chaos. We had a discussion and it reluctantly agreed that selecting the correct language was best for both itself and our customers. The heart wants what it wants, language picker, the heart wants what it wants. 💔
• 🆕 While we can't promise that your docs will be as stable as Simone Biles during a beam routine, we're happy to report that this release includes stability fixes for landing pages, in-documentation variables, and various form fields in the API Reference section. 🤸‍♀️
• Much like cats on the field during a baseball game, invalid request header formatting can derail an API documentation experience. Thankfully, it's easier to catch invalid header formatting, so this release includes some fixes on that front. ⚾
• This release includes minor improvements to the OpenAPI output of reference docs that are created using the manual editor. Your friendly neighborhood OpenAPI validator will thank you. 🏡
• 🆕 A lot of people h8 when a joke is repeated too many times. Although I've now learned that ReadMe condones the overuse of jokes, we do not appreci8 the repetitive firing of the pageLoad JavaScript event, which we've been seeing when navigating between certain pages. This week's release includes fixes to this pageLoad event, which should result in cleaner Google Analytics and Segment data. 📉

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

—Rahul, Kanad, and the ReadMe Team

(Kanad Aside) Shoutout to our engineering intern Rahul for an amazing summer and for taking the lead on writing this week's Owlet Weekly Update!

📘

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 spent the larger chunk of last week in a hackathon where lots of incredible work was done—much of which you'll see in this release! Major accessibility gains, new metrics sharing workflows, design improvements, and so much more. 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

• You know that sinking feeling when you're on an infinitely long road with seemingly no end in sight? While, in a twisted sense, that could be a metaphor for life itself, that's also a metaphor for paginating through our API results. While our response headers provided helpful information about accessing what's immediately in front of you and what's immediately behind you, there wasn't much information on accessing the destination... until today! As of this release, we've extended our existing Link response header and added a new x-total-count header which should hopefully alleviate that sinking feeling. Check out our pagination docs for more info! 🛣
• 🆕 As alluded to above, last week's hackathon yielded massive accessibility improvements across almost every aspect of the hub! Most of the changes are almost completely invisible in nature, but this release includes many contrast improvements and subtle changes to the markup to make pages easier to tab through and friendlier for screen readers. More to come on this front! 🎉
• 🆕 We've made some performance improvements (as well as some tiny design improvements) to landing pages! They should be zippier during initial render and when navigating between other sections of your docs. 🏡
• 🆕 This release includes a fancy new toggle in the API Reference section that makes it easy to securely share individual API logs with others, as well as some other small metrics UI improvements. 🤝

🛠 Fixes & Updates

• 🆕 Fixed an issue where links to API Reference pages that contained hash parameters were inadvertently redirecting. This was due to a false positive with some redirect logic we have in place to handle redirects from pages in the legacy reference section design to the newly redesigned reference section. Check out our migration guide for more information on ensuring your legacy links continue to work as expected! ⛓️
• The login button was having a bit of trouble reading the room in very specific cases—in other words, showing up when it wasn't supposed to, and not appearing when it should. Thankfully, we've given it a bit of a pep talk and it should be appearing as expected. 🔐
• 🆕 This release fixes an issue with our Markdown parser where it was basically impossible to write links that open in a new tab (like this one!). All you need is a standard HTML <a> tag with a target="_blank" attribute. 🔗
• 🆕 If you're reading this on your phone, you're probably aware of this already... but this release includes responsiveness improvements in the Changelog! 📱
• 🆕 Stability improvements for navigation between certain pages. 🧭
• 🆕 Minor tweaks to robots.txt. 🤖

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