Hello and welcome to another Owlet Weekly Update! This week we're shipping lots of fixes to the API Reference section, continuing to polish up our new Metrics experience, and more. 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 previously announced, our new Metrics experience has officially starting rolling out! This release contains more polish on the Metrics front before we officially launch it to the masses early next year. If you've gotten a chance to play around and have any feedback for us, please drop us a line! 📊
• 🆕 Various stability improvements related to the sharing and displaying of Request History in the API Reference section. 🪵

🛠 Fixes & Updates

• 🆕 There was a periodic issue in the API Reference section where we would sometimes show a "Log Out" button even when you were already logged out, causing widespread panic and confusion. Happy to report that this release brings some semblance of relief. 😌
• Fixes a bug where if a manual API definition property had an enum, it wouldn't be reflected as such in the API Reference. 🪞
• 🆕 This release includes a fix related to page views to ensure that we're not double-counting page views. 🧬
• Fixed an issue related to how our api package loads OpenAPI files using our custom extensions. 🧩
• Fixed a permissions issue for users logging in through our new passwordless login flow. 👥
• Some stability improvements for a small subset of API Reference pages. 💥
• 🆕 Fixed some styling breakages with our schema tooltips. 💅

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 Thanksgiving week folks! It's a short work week for most of us due to the holiday, but that didn't stop us from cooking up some exciting things—details below! 🦃

📘

Release Scheduling Update

We're now ramping up our release frequency to be nearly daily, so these Changelog posts will be published on the Monday following the previous week of releases, with the post covering everything that went out during that week. The publishing date is backdated to the time of the last release of the week. We appreciate your patience as we workshop this process!

👍

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 part of some major ongoing authentication improvements underway, we've enhanced the recently-redesigned login pages to now support passwordless logins! Now your users can simply opt to receive a login link in their inbox rather than typing "password123"* into yet another field. 📥
• As previously announced, our new Metrics experience has officially starting rolling out! This release contains more polish on the Metrics front before we officially launch it to the masses early next year. If you've gotten a chance to play around and have any feedback for us, please drop us a line! 📊
• 🆕 This release includes a nice little addition for response examples in the API Reference section: headers! If you've documented example response headers, they now show up the same way they would if someone hit the "Try It!" button. ⚽
• All you favicon fiends out there may have noticed that we finally refreshed the color of our logo for dashboard pages. 💙

🛠 Fixes & Updates

• 🆕 Fixed an issue where navigating to a different version of the docs would occasionally take you to the wrong place. 🧭
• 🆕 Tweaking some hover states to make some things more obviously clickable in the API Reference section. 🪤
• More improvements to our new editor, which you can play around with in our discussion forums! ✍️
• 🆕 Fixed an issue where TypeScript code samples weren't properly being categorized as such. 🗃
• 🆕 A few copy edits and fixes for the callback support we shipped last week. 🍌
• 🆕 Some minor keyboard navigation fixes in the discussion forums. ⌨️

*DISCLAIMER: This is a joke, please use a secure password instead!

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! We're officially unveiling our new Metrics experience into the universe and shipping sh*t that's B-A-N-A-N-A-S. 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

• 🆕 Good news if you enjoy stomping your feet with the girls, have been around the track a few times, and refuse to let it happen like that: with this release, we have officially shipped call-a-back girl supp—wait... uh oh. (sigh) y'all... I read this completely wrong. Let's try again: with this release, we have officially shipped callback support in the API Reference section. Brownie points if you implement this endpoint for events related to Gwen Stefani (and NOT Blake Shelton). See here for an example of the new functionality. 🗣
• So you might notice something a little (or a lot, rather) different when you log in to your project dashboard... we've officially rolled out our new Metrics improvements to everyone! When you load up your project, you'll step into a completely revamped dashboard with various top-level insights on your API usage, users, and docs. It's been completely redesigned to make it easy (and fast!) to explore all of this valuable information. Check out our docs to learn more and drop us a line if you have any feedback! 📊
• You can now set variables at the enterprise parent project level. This will make it much easier to have a unified variables experience across all of your child projects—a Hallie and Annie situation, if you will. 👯

🛠 Fixes & Updates

• The docs for our GET /api-specification endpoint have long claimed that we do not require the x-readme-version header and that we'd default to your project's main version if you don't include that header, but turns out that was... completely false. We made some behind-the-scenes updates to actually live up to this claim. 🤥
• 🆕 This release addresses several quirks for endpoints with multiple authentication schemes so the docs can better handle the credentials that you select. 🔑
• Fixed an issue where hovering your cursor over the lefthand column of items in the dashboard wasn't properly revealing their titles. 🎩
• This release fixes an issue where several users were unable to log into their documentation via SAML. 🔐
• Resolved some workflow issues regarding suggested edits for projects with a staging environment. 🔀
• 🆕 This release addresses a handful of issues with client-side navigation on enterprise projects. 🧭
• 🆕 Polished up some styling on the server variable menus in the the API Reference. 💅

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

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