Various improvements and fixes this week, including a big performance bump for the Metrics experience in the hubs and a new partnership to keep your API keys secure. More below! 🤝

✨ New & Improved

• The beta rollout of our new editor continues! I’m actually using it as we speak to write this and I can attest to it being the absolute bee's knees. This release includes more fixes on that front. If you want to get access (and sign up for any of our other upcoming betas 👀), fill out this form. ✍️
• We're officially a GitHub secret scanning partner, y'all! We've partnered with them to ensure your API keys remain safe in GitHub repos. Get the details on API key management and the partnership in our docs! 🔐
• This release includes a big performance improvement to how your customers view their API logs in the hubs. 🚀
• A couple of touch-ups to audit logs so they're a bit more readable. 🪵

🛠 Fixes & Updates

• This release includes a few tiny improvements to our session invalidation logic. 🔑
• Resolved an extremely rare edge case causing the dashboard to crash. 💥
• Fixed a couple of navigational issues for certain projects. 🧭
• Fixed some tag-related funk in the Discussion Forums. 🏷️
• Minor search indexing improvements. 🔍

Hope you're staying safe and healthy! Thanks 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, y'all! Even though we wrapped up Customer Appreciation Week last week, we're still tying up some loose ends on some of that work. Lots of stuff went out this week, including improvements to file uploads, Metrics onboarding, and more. Details below! 🪢

✨ New & Improved

• This release includes a major overhaul to how we handle file uploads in the API Reference! We now do a better job of handling a variety of different file types and preserving file metadata (file name, file type, etc.). Additionally, the corresponding code samples are much cleaner and more actionable. Oh and I almost forgot—you can now upload multiple files at once! Lots of good stuff here, y'all. 🗃️
• The beta rollout of our new editor continues! I’m actually using it as we speak to write this and I can attest to it being the absolute bee's knees. We’re continuing to ship more features for it, including a long-requested raw mode! If you want to get access (and sign up for any of our other upcoming betas 👀), fill out this form. ✍️
• We’re not one to make assumptions, but we've decided to make a small change in the API Reference when it comes to enum values: if you have only one value, we safely assume it’s the default value. ☝️
• This release includes a variety of little improvements to our Metrics onboarding experience. 👋
• As of this release, we now support the description field for Server Objects. ✍️
• Some minor touch-ups to the api code samples. 💅

🛠 Fixes & Updates

• When it comes to following a recipe, certain steps take much longer than others. In this release, we’ve fixed some of our styling to better handle longer steps. 🍳
• Certain customers were having issues accessing their discussion forums—this release addresses those issues. 💬
• If uploading an API definition to ReadMe fails for any reason, we now do a better job of cleaning up the mess. 🧹
• This release includes some improvements to how we handle page scrolling for hash links. 📜
• This release includes some work to ensure that links don’t break if you rename a recipe. 🔗
• Some small markup improvements to better reflect any page metadata that you specify. 🔍
• Fixed some linking issues when navigating between different project versions. 🧭
• Fixed an extremely obscure edge case with page slug uniqueness. 💯

Hope you're staying safe and healthy! Thanks 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]!

It's Customer Appreciation Week (or CAW 🗣, for short), y'all! We spent the week hanging out at apidays, shouting out a few hubs that we love, and addressing a bunch of long-standing bugs and feature requests (nearly 40 in total!). See below for the highlight reel! 🦉

✨ New & Improved

• The beta rollout of our new editor continues! I’m actually using it as we speak to write this and I can attest to it being the absolute bee's knees. This release includes even more work on this front! If you want to get access (and sign up for any of our other upcoming betas 👀), fill out this form. ✍️
• This release includes rdme syncing support for Changelog and Custom Pages! Similar to Guides, this means you can sync a directory of Markdown files to ReadMe via GitHub Action or command-line. 🔄
• When viewing individual API logs in the Metrics Dashboard, we now surface the email address of that API log’s user and added a convenient li’l button to quickly filter for all requests from that user. 📧
• This release includes a bunch of tiny touch-ups to code samples in the API Reference. More consistent usage of quotation marks, import patterns, indentation, and more. 🧹
• Various improvements to search, both on the performance and visual fronts. 🔍
• Some visual touch-ups to make our scroll bars dark in the right places. 🌚

🛠 Fixes & Updates

• Fixed some issues across the board in the hubs where certain buttons and links were not taking you to where you were supposed to go. 🔗
• Fixed an issue where project invitation emails wouldn’t properly send to your friends if their email addresses contained certain special characters. 📤
• Fixed an issue in the API reference where parameter descriptions for response object parameters were experiencing width issues. 😳
• Fixed an issue where hidden reference pages were getting crawled. 👻
• This release includes a few small fixes around version creation. ♻️
• Some minor fixes related to Enterprise Authentication. 👥

💙 Miscellaneous Customer Appreciation

• A few members of the team traveled from the Midwest to hang out at apidays NYC! Great conversations about DX were had, Owlbert stickers were doled out, and attendees had quite a bit of fun with an API we built just for the occasion. 🗽
• Miche took to the blog to discuss some of little details in our customers' developer hubs (such as Tomorrow.io, Capable Health, and Gusto) that make a big DX impact. 🧭
• And lastly, what's a themed week at ReadMe without a musical number from Pat? 🪗

Hope you're staying safe and healthy! Thanks 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]!

This week we're making some improvements to search, JWT tokens, and more. Details below! ♌

✨ New & Improved

• The beta rollout of our new editor continues! I’m actually using it as we speak to write this and I can attest to it being the absolute bee's knees. This release includes even more work on this front—including long-requested support for alt-text in images! If you want to get access (and sign up for any of our other upcoming betas 👀), fill out this form. ✍️
• Previously, our search indexing would only support H1 - H3 headers. This release improves upon our search indexing functionality to now search for H4 and H5 headers. We love a deeply nested content hierarchy! 🪆
• A couple security improvements for JWT tokens used to access the ReadMe documentation. 🔐

🛠 Fixes & Updates

• Smol fix for an edge case that was preventing certain Metrics dashboards from loading. 📊

Hope you're staying safe and healthy! Take care, 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]!

A few small changes to call out this week while we work on some bigger projects. More below! 👀

✨ New & Improved

• The beta rollout of our new editor continues! I’m actually using it as we speak to write this and I can attest to it being the absolute bee's knees. If you want to get access (and sign up for any of our other upcoming betas 👀), fill out this form! ✍️
• Smol touch-ups to some of our emails. 📧

🛠 Fixes & Updates

• Some of our users were seeing misleading 500 errors when using our API. This release makes them slightly more… leading. 🧭
• Fixed some styling issues with multi-select fields in the API Reference. 🖌️
• Minor security fixes. 🔐

Hope you're staying safe and healthy! Take care, 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]!

Hiya! We're continuing our editor rollout and addressing a bunch of bugs. More below! 💐

✨ New & Improved

• The beta rollout of our new editor continues! I’m actually using it as we speak to write this and I can attest to it being the absolute bee's knees. If you want to get access (and sign up for any of our other upcoming betas 👀), fill out this form! ✍️

🛠 Fixes & Updates

• Fixed an issue in the API Explorer where the “Try It!” feature would prevent users from making Basic Authentication requests that didn’t contain a username. With the fixes included in this release, you can freely make those username-less requests. 🔑
• Fixed an issue where certain fancier page content pieces would render as [object] [Object] in search results. 🔍
• Fixed some redirect issues for folks that were navigating from the dashboard to the hubs. 🧭
• Various bug fixes related to Metrics. 📈
• Fixed some quirks with project cloning. 🧬

Hope you're staying safe and healthy! Take care, folks.

—Kanad and the ReadMe team

📘

What is the Owlet Weekly Update?

Thanks for tuning in to another edition of our Owlet Weekly Update—an owlet-sized update (posted every week to the ReadMe Changelog) on the product updates we're shipping here at ReadMe. We'd love to hear what you think of these updates at [email protected]!

We're continuing our editor beta rollout amongst a couple of other fixes this week. More below!

✨ New & Improved

• The beta rollout of our new editor continues! I’m actually using it as we speak to write this and I can attest to it being the absolute bee's knees. If you want to get access to it (and sign up for any of our other upcoming betas 👀), fill out this form! ✍️

🛠 Fixes & Updates

• If you’ve ever interacted with the Node.js code samples in the API reference, you’ll notice that we previously listed fetch listed as an option. We’ve now clarified in the selection menu that that code sample is in fact node-fetch and not the fetch that Node.js recently added support for (which we will add support for soon!). 🦴
• Fixed a few issues with permissioning, staging, and SEO on Enterprise projects. 👥
• A few security fixes. 🔐

Hope you're staying safe and healthy! Take care, 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 gonna lie, it's been a rough week y'all. But we're moving forward. Read onward to see what we worked on this week!

✨ New & Improved

• When choosing a library for a given language in the API Reference (i.e. choosing between api and node-fetch within the Node.js options), your ReadMe docs will now magically remember your library selections between page loads. 🧠
• We’ve made some performance and overflow improvements to the Request and Response sections in the API Reference for when those sections are rendering tons and tons of content. 🍱
• Performance and design improvements on the Enterprise Global Landing Page. 🚀
• Added support for WebDAV status codes in the manual API editor. 💯

🛠 Fixes & Updates

• Some security- and email-related improvements to Suggested Edits. 📝
• Fixed some crashing issues on landing pages. 💥
• Fixed an issue loading API logs in the hubs. 🪵

Hope you're staying safe and healthy! Take care, y'all.

—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, y'all! This week we're recovering from a company offsite, shipping several fixes, and making headway on some major projects. More below! 🌴

📘

Programming Note 🌺

You may have noticed that there wasn't an update last week (the week of June 6th). That's because we were at a company offsite all week. Because of this, we paused our deployment schedule. But we're back and shipping code this week! Appreciate your patience, folks.

✨ New & Improved

• The beta rollout of our new editor is currently underway! I’m actually using it as we speak to write this and I can attest to it being the absolute bee's knees. If you want to get access to it (and sign up for any of our other upcoming betas 👀), fill out this form! ✍️

🛠 Fixes & Updates

• Fixed an issue in the API Reference where certain APIs with multiple authentication types would send improper request headers when hitting “Try It!”. ♊
• Embedding Recipes in the Guides was looking a little funky (in a bad way), so this release fixes that. 🕺
• Fixed an issue where users were having troubles accessing their API logs from the hub. 🪵
• Small UI fixes with some speech bubbles in the Metrics dashboard. 💬

Hope you're staying safe and healthy! Thanks 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 (almost) June, friends! This week we're making improvements to how we render response examples in the API reference, improving our API key management, and lots more. Let's dive in! 🌤️

✨ New & Improved

• If you’ve been following our changelog, you’ll notice that we recently had an incident involving ReadMe API Keys. The not-so-great news is that we made the decision to revoke and replace all ReadMe API keys, but the good news is that we rolled out a fancy new dashboard for managing your keys. Be sure to check out our incident post-mortem and our API Key Rotation FAQ to get all the info. 🔐
• As part of this release, we made a small but exciting update to how we render API response examples in the API Reference so we can now display examples for different media types! In other words, if you have example responses defined in JSON and XML, we now display both of them and specify the respective media types (i.e. application/json and application/xml), rather than defaulting to JSON. 🌈
• The beta rollout of our new editor is currently underway! I’m actually using it as we speak to write this and I can attest to it being the absolute bee's knees. If you want to get access to it (and sign up for any of our other upcoming betas 👀), fill out this form! ✍️
• We’re in the process of rolling out our new Enterprise Authentication experience! This release includes more work on that front. Get the details on everything here! 🔑

🛠 Fixes & Updates

• This release addresses a handful of schema generation bugs for OpenAPI definitions generated from using our Manual API editor. ♻️

Hope you're staying safe and healthy! Thanks 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]!