I'm not gonna stop, that's who I am (Who I am)
I'll give it all I got, that is my plan (That's my plan)

—Troy Bolton (circa 2007), and all of us as we ship redesigned login pages and even more metrics and bug fixes despite attending our company offsite. More below! ⛳

📘

Delayed Update

Most of the team was at our quarterly offsite this week! This post goes over everything that was shipped the week of November 8th, but due to the offsite and a company holiday, we didn't have a chance to publish the changelog until the following week (around November 18th). Appreciate your patience, folks!

👍

We've been rolling out a redesigned docs experience for some time now—check out this page for the details! Changes that are only applicable to the redesigned docs experience will be prefixed with a 🆕 emoji. The legacy docs style will be deprecated on December 31, 2021.

✨ New & Improved

• Ahead of lots of authentication improvements coming your way (stay tuned! 👀), this release includes a completely redesigned login page for your users when they log in into your docs. In addition to a much sleeker design with 100% fancier loading states, the login page is much more tailored to the look and feel of your docs and features your logo prominently at the top! Perhaps most importantly, your users will no longer feel catfished when seeing the ReadMe logo on the login page. 100% Nev approved. 🐟
• As we continually allude to, we're working on some exciting updates to the metrics experience! This release includes even more tire-kicking to make sure it's ready for game day. If you're interested in seeing what the hype (mostly generated by that single event and these extremely popular Changelog posts) is all about, you can sign up for the beta program now! 📊

🛠 Fixes & Updates

• Fixed an issue where certain API specifications that were constructed using the manual editor weren't playing nicely with the SDKs generated by the api package. 🎲
• 🆕 This release addresses an issue where certain users were having issues redirecting back to the docs after suggesting an edit. 📝
• Fixed a minor styling issue where the Recipes modal didn't play nicely with tall screens. 🖥
• Addressed a security vulnerability related to URL redirects. 🔐
• Minor copy updates in the dashboard. ✍️

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 Christmas season folks! (I said what I said.) We're kicking off our November with flair, bug fixes galore, and a beta release of a feature we've been working on since this time last year! Read on for all the juicy details. 🎄

👍

We've been rolling out a redesigned docs experience for some time now—check out this page for the details! Changes that are only applicable to the redesigned docs experience will be prefixed with a 🆕 emoji. The legacy docs style will be deprecated on December 31, 2021.

✨ New & Improved

• 🆕 We've been working on updating our editing experience for some time, and we're excited to start sharing them with you! Check out the discussion section in our docs to see what we've been working on! ✍️
• As we continually allude to, we're working on some exciting updates to the metrics experience! This release includes even more of behind-the-scenes work so it's ready for primetime. We officially kicked off our beta program with a sneak peek event earlier this week—if you're interested in seeing what the hype (mostly generated by that single event and these extremely popular Changelog posts) is all about, you can sign up for the beta program now! 📊

🛠 Fixes & Updates

• So... um... you know how we mentioned some big improvements with the weekly Slack metrics update a few weeks ago? And how we specifically said "it should actually hit your Slack inbox as expected", which implied that it wasn't hitting your Slack inboxes before and it should have done so after that release? Well... turns out we needed some additional configuration to make that happen. Now, it should (hopefully) actually hit your Slack inboxes as expected this coming Monday! 📬
• 🆕 Fixed an issue where custom section names weren't properly being reflected in the search modal. 🔍

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

—Mostly Kanad, a tiny bit Naomi, and the (emotional) support of 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 Halloween Double Eve(?), folks! In honor of this momentous day that I absolutely did not just make up, we're getting closer to our newly improved metrics experience rollout while squashing several bugs that have been absolutely terrifying to deal with. Details below! 🕷️

👍

We've been rolling out a redesigned docs experience for some time now—check out this page for the details! Changes that are only applicable to the redesigned docs experience will be prefixed with a 🆕 emoji. The legacy docs style will be deprecated on December 31, 2021.

✨ New & Improved

• As we continually allude to, we're working on some exciting updates to the metrics experience! This release includes even more of behind-the-scenes work so it's ready for primetime. We have a sneak peek event on this coming Tuesday, November 2nd—you can RSVP here! 📆
• 🆕 Infinitesimally small styling improvements in various dropdowns. 🖌️

🛠 Fixes & Updates

• 🆕 As part of the routing architecture in the refreshed documentation, one benefit is wickedly-fast page navigation. But sometimes, there was an issue where the web browser was simply too fast to know what to do with itself, and would occasionally fail to update page content as you clicked between different pages. This release should quell the browser's ego while still keeping things zippy. 🚄
• 🆕 This release includes a fix for apples that were falling a bit too far from the tree. In other words, certain enterprise projects were experiencing an issue where parent project properties (e.g. glossary terms, custom JS or CSS, etc.) weren't properly being applied to children. 🍎
• Fixed an issue where the "Add to Slack" button ate too much candy corn and temporarily couldn't hang. 🥴
• 🆕 Small fixes to our tooltips and deprecated parameter fields as a follow-up to last week's release.
• 🆕 Fixed an issue where certain discussion forums would 404 when clicking on their tags. 🏷
• Fixed an issue where certain deleted pages were showing up in search results. 🚮

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 weekly update, friends! With the northern hemisphere's ongoing deprecation of leaves, it's fitting that we ship support for the deprecated keyword in the API Reference! We're also working on some big upcoming metrics updates, shipping more Slack App updates, and fixing a few bugs. More below! 🍂

👍

We've been rolling out a redesigned docs experience for some time now—check out this page for the details! Changes that are only applicable to the redesigned docs experience will be prefixed with a 🆕 emoji. The legacy docs style will be deprecated on December 31, 2021.

✨ New & Improved

• 🆕 With the deprecation of Mercury Retrograde, Daniel Craig as James Bond, Ryan from the Bachelorette... the deprecation jokes write themselves and I could go on forever, but the main takeaway is that our API Reference now supports the deprecated keyword! Now, if you upload an OpenAPI file with deprecated endpoints and/or deprecated parameters, the API reference section will surface several hints to your users that it's time to get with the times. Check out an example here! 🌹
• As we continually allude to, we're working on some exciting updates to the metrics experience! This release includes even more of behind-the-scenes work so it's ready for primetime. We have a sneak peek event on November 2nd—you can RSVP here! 📆
• As part of upcoming changes mentioned above, the weekly Slack updates on your documentation and API metrics have now been refreshed to send you even better insights than before! Oh, and it should actually hit your Slack inbox as expected. 📰
• 🆕 For those of you with lively developer communities that are constantly blowing up your discussion forums, we've added pagination to the bottom of the main discussion forum page so it's easier to navigate through all the banter. 🗣

🛠 Fixes & Updates

• 🆕 Seeing as I have zero professional titles, I was always thrown off by this bit where white people at my high school would jokingly call me "Dr. Gupta". Cut it out Noah, I am literally 16 years old and I am not related to CNN's chief medical correspondent! Have you seen his hairline? Anyways, we had an issue where certain fields in the API Reference were being denoted by their title values, rather than their names. While this release won't fix Western culture's hazy understanding of South Asian surnames, this release eliminates some of the confusion with fields in the reference section. 📛
• 🆕 There was an issue where schema types were inadvertently displaying with a capitalized first letter. This release restores these schema types to their true form. 🌱
• Seeing as society as a whole does not care about the casing in your email address, we are now adhering to this social norm when you've forgotten your password. 📧
• 🆕 Fixed an issue where certain characters weren't properly rendering in the navigation bar. ❓
• 🆕 Fixed some spacing issues that were affecting certain 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]!

Hello and welcome to another weekly update friends! Spooky season continues for yet another week with ongoing metrics updates (stay tuned!), API reference improvements, and various fixes. Details below! 🍁

👍

We've been rolling out a redesigned docs experience for some time now—check out this page for the details! Changes that are only applicable to the redesigned docs experience will be prefixed with a 🆕 emoji. The legacy docs style will be deprecated on December 31, 2021.

✨ New & Improved

• As alluded to last week, we're working on some exciting updates to the metrics experience! This release includes a lot of behind-the-scenes work so it's ready for primetime. If you'd like to receive beta access (the changes are only in the dashboard, so it won't affect your end users at all), feel free to get in touch! 📊
• This release includes a couple improvements for API Reference docs written using our Manual API Editor. Response examples now properly display the titles you set for them (🆕) and the auto-generated OpenAPI file should play more nicely with your friendly neighborhood validator. 🤝

🛠 Fixes & Updates

• 🆕 Fixed various issues around how we persist API authentication credentials between pages in the reference section. 🔑
• Fixed an issue where a select few Slack notification messages weren't being delivered. 📫
• Some minor fixes to our permissions logic for Enterprise Groups. 🔒
• 🆕 Fixed some spacing issues in the version dropdown. 🛰

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, folks! In preparation for this year's spooky season, we're rolling out some aesthetic tweaks and getting ready for a larger feature update coming soon. Read on for more details below! 🚄

👍

We've been rolling out some new docs designs for a little while now—check out this page for the details! Changes that are only applicable to the new docs design will be prefixed with a 🆕 emoji.

✨ New & Improved

• You might notice the dash sidebar has been touched up a little. These changes are coming in tandem with a larger metrics-related update we're busy getting ready for you! We've begun an internal rollout of this new feature, and if you're interested in getting involved with the beta coming soon, feel free to get in touch. 📊
• If you're feeling thirsty today, you're in luck--we've added support for generating PHP snippets that use Guzzle! Or if you're feeling a different kind of thirst, October (and most other months) is a great time to stay hydrated! 🚰

🛠 Fixes & Updates

• We're feeling great about our new API Reference experience, and we want everyone to join us in the fun! To that end, we'll be deprecating the legacy design on December 31, 2021. If you haven't made the switch just yet, check out the banner in your dash to see the preview and enable the new design! ✨
• We've made lots of stability improvements to snippet generation--query params will now always be encoded in snippets, extra headers have been removed, cookies are actually being used, and much more! You should feel empowered to get out there and continue generating as many snippets as you need! ✂️
• Some minor alignment fixes for enterprise sidebars, simplified pagination styling, and other aesthetic updates 👗
• A small update to make sure links to hidden reference pages in certain scenarios always work! 🔗

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, dear reader! This week we're celebrating ReadMe's birthday and remain focused on some bigger projects while shipping various fixes to our Slack integration, Recipes, and more. Details below! 🎂

👍

We've been rolling out some new docs designs for a little while now—check out this page for the details! Changes that are only applicable to the new docs design will be prefixed with a 🆕 emoji.

📘

We ended up re-publishing this post under a new URL to reflect some additional changes that went out early Friday morning PDT. Apologies for any confusion!

✨ New & Improved

• Much like my current motivation to empty clean dishes from the dishwasher, connections to our Slack integration would mysteriously disappear. While there's no software that an engineer could write that will address my current personal crisis, this release includes several behind-the-scenes improvements to our Slack integration to use Slack's current guidance on authenticating with your Slack workspace and to prevent the mysterious disappearances. 🍽
• 🆕 This release includes a few subtle tweaks to the page markup which should help with accessibility, performance, and security. 💡
• Better handling of bigger user data payloads. 🪣

🛠 Fixes & Updates

• This release addresses a few Recipes-related bugs. The first is an issue where certain internal documentation links within Recipe steps were broken. The second is a minor styling issue where, in certain instances, the embeddable Recipes tiles weren't floaty enough. Happy to report that these links should take you to the right place and that the floatiness has ascended to normal levels. 🎈
• 🆕 Fixed an issue where users were unable to add comments to discussion posts on projects with reCAPTCHA enabled.
• Fixed an issue where certain Suggested Edits weren't rendering properly in the dashboard. 📝
• 🆕 Fixed a few quirks with the routing behavior on enterprise projects with custom child path names. 🧭
• Fixed an issue where variables weren't rendering in certain parts of the Changelog. 📛

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 weekly update, friends! While we remain mostly heads down on some bigger features, this week we're shipping a few bug fixes and poppin' tags*. Details below! 💸

👍

We've been rolling out some new docs designs for a little while now—check out this page for the details! Changes that are only applicable to the new docs design will be prefixed with a 🆕 emoji.

✨ New & Improved

• 🆕 Tag, you're it! Just kidding. You're not "it". But you know who is? Your users when they view your API Reference docs, now that we've shipped drastically improved support for Tag Objects as part of this release! Now, if your OpenAPI file contains description and/or externalDocs properties, we now display them in a cute lil' tag icon to the right of the title. See below for an example! 🏷

🛠 Fixes & Updates

• Fixed an issue where users were having trouble embedding Recipes on certain Custom Pages. 🍽️
• Minor accessibility improvements with the Previous/Next navigational buttons. 🔙
• Fixed some tiny quirks with project ownership transfers. 🤝

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

—Kanad and the ReadMe Team

*DISCLAIMER: This pun is in NO WAY an endorsement of Macklemore, nor is it an endorsement of his music. Additionally, we actively reject the results of the 2014 Grammy Awards.

📘

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, folks! A bit of a smaller update this week as we're mostly heads down on some bigger features coming your way in the coming weeks. In the meantime, trying out a new deployment cadence, engaging in some riveting best-food-on-a-stick discourse, and fixing a few bugs. More below! 🎙️

📘

New Deployment Schedule

This week was the debut of our two-deployment-per-week schedule (Tuesdays and Thursdays) as opposed to our typical once-a-week-on-Tuesday-and-sometimes-a-different-day schedule. The goal is to ship code faster and in smaller, less disruptive releases. 🚀

The plan is to write a single Owlet Weekly Update per week which goes over everything that went out in both of the weekly releases. We appreciate you sticking with us as we workshop a new process. Stay tuned for updates as this process continues to evolve!

👍

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.

📆 Upcoming (and Past) Events

• We wrapped up a super fun and informative chat with Shaun VanWeelden, Head of Field Engineering at Scale AI! The conversation wandered from sharing our Midwest state fair experiences to scaling out a documentation process across a growing organization, and everything in between (well, not everything, because those are completely unrelated). If you RSVP'd, you can check out the the event page for a recording! 🎡

✨ New & Improved

• 🆕 Made a few small copy updates to the page pagination controls so they make more sense and a global .rm-Pagination class (see our docs to see all of the available global classes!) so they're easier to customize. ⏪

🛠 Fixes & Updates

• Fixed an authentication redirect issue affecting certain Enterprise projects where attempting to suggest an edit would take you to the wrong place. 🔐
• 🆕 Fixed an issue where certain projects were experiencing issues adding votes and comments to Discussion Forums. 💬
• 🆕 Better handling in the API Reference section for endpoints with empty content objects in the response. 📭
• Fixed a minor redirect bug with localization. 🌎

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 weekly update, folks! In honor of Beyoncé, we're shipping design refreshes and fixing bugs. 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.

📆 Upcoming Events

• Next week, I'll be hosting a Q&A with Shaun VanWeelden, Head of Field Engineering at Scale AI! Scale is one of our fastest growing customers (and I gotta say, they have absolutely incredible docs), so I'm excited to chat with Shaun about favorite foods on a stick, how Scale leverages ReadMe in supporting success on their platform, and more. You can submit a question and RSVP (if you can't make it live, we'll send you a recording of the conversation) on the event page! 💬

✨ New & Improved

• 🆕 This release includes a highly anticipated rewrite of Discussions! While all the functionality and features remain unchanged, everything has been redesigned from the ground up to be in-step with the design improvements we've been making throughout the hubs. With that also comes tons of under-the-hood performance improvements to make page loading and navigation lightning fast. And perhaps most notably, we said goodbye to Josh Smith in the anonymous form placeholder and hello to Beyoncé Knowles. 👑
• 🆕 Still on the fence about upgrading your project to the latest and greatest? We totally understand! Now when navigating to your project in the dashboard, you'll see an option to set up some time with Ehsan, our incredible Product Specialist, to get some help with the upgrade process. 🤝
• As part of some broader changes coming to the dashboard in the not-too-distant future, this release includes icon updates and an overall design refresh in the enterprise dashboard. 🍥

🛠 Fixes & Updates

• 🆕 Certain projects with disabled reference sections were dealing with a quirk where the reference sections were not found, but weren't properly displaying the 404 page and were instead yielding a blank page. Not only was this a weird and confusing user experience, but this would also cause Tim Berners-Lee to weep profusely without warning. This release stops Sir Berners-Lee's crying (about this, at least) and brings back the 404 page in these circumstances. 🥲
• 🆕 This release includes some goodies for you JSON Schema fiends! We've tweaked our handling of the additionalProperties field to overcome a limitation of JSON Schema: if you're attempting to combine fields from multiple objects via an $allOf but have additionalProperties set to false, we now combine them, rather than not rendering anything in the form at all. See this page for examples! 🫒
• 🆕 You know that feeling when you unwrap a gift and it’s way less exciting than you were hoping for? This one is y’all—on certain Landing Pages, documentation categories with four (and exactly four) pages had a "View More" link after the first three pages when, in fact, we could have just… shown you the fourth page. Welp. Thankfully, this release should quell the disappointment. 🎁
• 🆕 General design improvements to various input and select components throughout our product, most visibly a change that fixes an issue where mobile-width pages were doing this awkward slight zoom thing when tapping the page selector in the guides and API Reference sections. 💅
• 🆕 Much like Steve Wozniak on Dancing with the Stars, footer notification bars in the hubs were making appearances when they shouldn't be. While we can't erase DWTS history, this release includes a fix for those notification bars. 🕺
• 🆕 Various fixes so the response schemas and examples in the API Reference section play nicely with non-JSON media types. 🤝
• 🆕 Fixed an issue where configuring a binary data format with a default Data URL would occasionally crash the page. 🗃
• Fixed an issue where child projects were occasionally out of order in the dropdown on Enterprise Global Landing Pages. 🔀
• 🆕 Tiny color fixes in various places. 🌈

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