Customer StoriesReadMe Blog
Back to All
added

Owlet Weekly Update (Week of July 19)

July 21st, 2021

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