Hello and Happy New Year to all! Welcome to our first update of 2023, recapping all the December goodness. We've had a lot of folks out for the holidays, but that didn't stop us from shipping several exciting updates last month, particularly on the rdme front. More below! 🎁

  • Global Landing Page Improvements 🌍 with November's knowledge base revamp, you may have noticed our beautiful new global landing page (courtesy of Tony)! We want to make sure everyone can create a beautiful global landing page for their Enterprise Group with ease. We've shipped lots of little improvements on this front, including revamped Theme Editor settings, improved dark mode support and improved mobile-friendless. If you want to upgrade to the new global landing page, get in touch with your PXM!

  • New OpenAPI tools in rdme 🛠️ in the last few weeks, we shipped a slew of rdme releases. The highlights include a couple new commands to help you manage your OpenAPI definition: openapi:inspect and openapi:convert. The former performs a thorough analysis of your definition to help you understand what aspects of the OpenAPI Specification that your file utilizes, while the latter converts Swagger and Postman definitions to OpenAPI. Oh, and rdme also automatically handles GitHub blob URLs now!

That's "owl" for now, folks! Excited for what's to come in 2023 👀

—Kanad and the ReadMe team

📘

What is the Owlet Update?

Thanks for tuning in to another edition of our Owlet Update—an owlet-sized update (posted 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 a special World Cup-themed November edition of the Owlet Update! How is this Changelog post World Cup-themed, you might ask? Well due to the ongoing global recession and the rising cost of World Cup sponsorships, all we could afford was a single soccer ball emoji at the end of this paragraph. The last month brought many exciting developments, including kicking off the dark mode rollout, even more ways to personalize your developer experience, and much more. Details below! ⚽

  • Dark mode toggles for all 🌚 chances are, either you or somebody you know has strong opinions (perhaps overly so) about whether docs should be in dark or light mode. Well your developer hub no longer has to pick a side! If your project doesn't use custom CSS (hang tight CSS wizards, it's just around the corner for y'all!), you now have the ability to add a dark mode toggle to your developer hub. Check out the overview doc for info on how to enable dark mode and how to write custom CSS properly.

https://files.readme.io/a1fedbc-Dark_Mode_in_the_Hub-High_Res.gif

https://files.readme.io/f4c588d-GSA_Pages_in_Hub.gif

  • A revamped ReadMe knowledge base :owlbert-books: unless you exclusively read the Changelog and nothing else (and if you do, please email me so I can send you a fruit basket), you may have noticed some changes in our docs! We have a sleek new global landing page and we've completely overhauled our content structure to better reflect how we think about ReadMe. We're still ironing out a few kinks so if you notice anything out of place or any broken links, feel free to suggest an edit or contact us.

  • Support for importing Postman Collections 📬 now if you import a Postman Collection into ReadMe via any of our API definition import methods (file upload, CLI, GitHub Actions, etc.), we'll handle it the same way that we handle any ol' OpenAPI or Swagger definition and render it in your API Reference. Get the details on how this all works in our docs.
  • That's an Aka-mighty fine developer hub 💙 it was also Thanksgiving in the U.S. this past week, so we've been extra thankful for our amazing customers, including Akamai! Before ReadMe, they struggled to create a unified experience across their docs — now, they have a hub that works better for internal and external users alike. Read their story here.

That's "owl" for now, folks! As always, thanks for being a part of the ReadMe community.

—Kanad and the ReadMe team

📘

What is the Owlet Update?

Thanks for tuning in to another edition of our Owlet Update—an owlet-sized update (posted 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 a Libra/Scorpio/Halloween/Spooky/Fall/Autumn/Leaves/Apple/PSL-themed Owlet Update! This last month was busy here at ReadMe, with some exciting developer hub design updates, a new GitHub partnership and a couple major open-source project releases. More below! ♎ ♏ 🎃 👻 🍁 🍂 🍎 ☕

  • Dark Mode Preview 🌚 For several months now, we've been doing a lot of behind-the-scenes work on Dark Mode — coming soon to a developer hub near you! While there's still a bit of work left before it's ready for a wider release, you can now check out a preview of this in the ReadMe docs (a.k.a. the docs you're currently reading). Try the little ☀️ / 🌙 toggle in the top-right corner of the page 👀
Dork—I mean—Dark mode, coming soon to a developer hub near you!

Dark mode, coming soon to a developer hub near you!

  • [email protected] 🌊 Version 🎱 of rdme (ReadMe's official command-line interface and GitHub Action) features a brand new onboarding experience for setting up a GitHub Actions workflow (see a demo below!), as well as an improved login experience and a handy reducer tool (useful for debugging problematic paths or tags in your OpenAPI definition). Oh, and as part of this launch, we're officially a GitHub Technology Partner! Check out the announcement on our blog to learn more about this massive release.
  • [email protected] 🚀 We'll have more to say soon, but version 5.0 of the api SDK is now out! It leverages a new approach to generating a beautiful SDK client for your OpenAPI definition, complete with types, parameter descriptions, and an improved response pattern. TypeScript, JavaScript, CommonJS, ES Modules, you name it! Check out our brand new docs to learn more.
  • All of your validation errors at once 💥 Now when uploading an OpenAPI definition to ReadMe (or when validating a definition with rdme openapi:validate), you'll get all of your validation errors in one go, as opposed to the previous dance of fixing an error, revalidating, seeing another error, fixing that, and so on.
  • Refreshed Changelog Icons 🎨 You may have noticed the icons on our Changelog (like the green ➕ at the top of this page) look a little different! And you'd be correct.

That's "owl" for now, folks! As always, thanks for being a part of the ReadMe community.

—Kanad and the ReadMe team

📘

What is the Owlet Update?

Thanks for tuning in to another edition of our Owlet Update—an owlet-sized update (posted 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 folks, welcome to our new monthly format for the Owlet Update! This edition covers our exciting product updates from the last 6 weeks or so, and going forward we’ll be publishing on a monthly cadence. Lots of exciting updates to share since we last wrote: lots of new features (of both the big and small variety) and a new partnership. Read on below, and stay tuned for the next edition soon! :owlbert-reading:

  • New ways to personalize your docs 🚀 Behind every API call is a unique developer, so why should every one of them have the same experience in your developer hub? That's why we rolled out Personalized Docs, a brand-new way to surface custom data (like API keys) for your users. If you navigate to your project dashboard, you'll find a brand new page to help you set up the Personalized Docs Webhook. Want to learn more? Check out the docs and the announcement on our blog!

A demo of the Personalized Docs dashboard

  • A new staging experience 🎭 By now you might be aware of Staging, an Enterprise environment that enables greater control around how your team previews and publishes changes. In the last month, we've rolled out a completely new Staging experience in the dashboard. Administrators now have far more flexibility and visibility around how changes are published. Check out our blog post and our docs to get the details.

A demo of the brand new staging experience

That's "owl" for now, folks! As always, thanks for being a part of the ReadMe community.

—Kanad and the ReadMe team

📘

What is the Owlet Update?

Thanks for tuning in to another edition of our Owlet Update—an owlet-sized update (posted 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 update, folks! We have a bit of a programming update to share and a little performance improvement to call out. More below!

  • This week, we shipped a performance improvement to our hubs that should significantly reduce the amount of HTML being sent on initial page loads, particularly for projects that contain lots of large pages. 🚀

Hope you're staying safe and healthy! Thanks for being a part of the ReadMe community, folks.

—Kanad and the ReadMe team

📘

Programming Note

Going forward, we'll be focusing our updates on major product features and improvements. We'll have one final update near the end of August September and then every update going forward will be on a monthly basis. Appreciate you tuning in!

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

Hope you're staying safe and healthy! Thanks for being a part of the ReadMe community, folks.

—Kanad and the ReadMe team :owlbert:

📘

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