Owlet Weekly Update (Week of July 27)

Hello and happy Leo season to those who celebrate! It's only reasonable that I come to you in the bold season of the Lion with some bold updates to ReadMe — well fear not! 🦁 This week includes many bold(-ish... it's all relative, I suppose!) updates, including links to API logs in every response, SSR for our Markdown engine, and a whole lot more. Details below! ♌️

✨New & Improved

• A couple weeks ago, we announced some sweeping improvements to the ReadMe API's error responses, including a unique link to an API log in every error response (powered by API Metrics!). We just expanded upon this in a substantial way—now every response from the ReadMe API includes a x-documentation-url header that includes a link to the API log in the ReadMe API documentation. But that's not all! The latest versions of our API Metrics SDKs include this response header enhancement as well. In other words, you can easily connect your API to ReadMe and users will see this x-documentation-url response header and will be able to access their API logs within your documentation! We think this will be a serious game changer for anybody that's looking to elevate their API experience. Check out our docs to learn how to connect your API to ReadMe and get this set up! 🏀
• This release includes a major performance milestone for our Markdown engine—server-side rendering! What does this mean? We now pre-render Markdown on the server, which lets us deliver lighter bundles, and translates to increased performance and faster loads for developers down the line! 🚀
• Good news for all you iPad, Fire HD, Galaxy Tab (yes, all two of you who read API docs on your Galaxy Tab), and any other tablet users out there—no more awkward spacing when looking at our guides! Responsive design improvements have been made all across the board, most notably in the sidebar and footer. (Any better ideas for a tablet emoji?) 💻 / 📱
• Various search improvements, including indexing improvements and linking improvements for Enterprise projects and projects with multiple versions and/or languages. 🔍
• Even our users of ReadMe Free deserve nice things! Including the ability to transfer project ownership. Starting today, you can! Hooray for nice things! 🤝
• Various coloring improvements on the new search modal to further ensure that it matches your project's color scheme. 🎨
• For projects with split API Reference sections, the sidebar will now properly scroll when selecting a different section! 🖱️
• Added preliminary support in the API Explorer for circular references in OpenAPI documents. If you know, you know. 🔄
• Minor spacing improvements in the API Reference section. 💄

🛠 Fixes & Updates

• Remember how last week we proudly declared victory over grammar failure in our call-to-action buttons? Well as it turns out, we missed a few spots. Welp. You may notice more "Login" ➡️ "Log In" updates in this release. Grammar is important, folks! 🤓
• We were seeing a mysterious issue where if you created multiple page categories that have the same name, you may see weird issues like the inability to delete categories and even disappearing pages. Yikes! Happy to report that we identified the root issue and included a fix in this release. 👻
• For the last couple weeks or so, you may have noticed a brief flash of incorrect, or duplicated content when initially loading the sidebar on certain projects. No, it wasn't just your imagination! Thankfully, this release includes a fix which should put your mind (and sidebar) at ease. ⚡
• We saw an issue affecting a small percentage of API Reference sections where our cache was causing pages to only partially load, causing them to look a little funky (to put it lightly). Happy to report that this has been fixed! 🕺🏽
• Fixes to a save issue in the project dashboard affecting a small percentage of pages. 💾
• Minor fixes to our email notifications. ✉️
• Other minor design tweaks and stability improvements. 💄
• And last but not least... we finally eradicated a tiny but nevertheless oft-mentioned (internally, at least) annoyance when creating a project on ReadMe—the requirement to upload a logo! Now, when you don't upload a logo, we just backfill the sample ReadMe logo for you, rather than requiring the additional click to do so. It's all about the big little details, folks! 💫

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

(Major shout-outs go out to our resident Owlbert cartoonist Paul Cox for creating our Owlet Weekly Update image! And also to Greg for building out a headline generator on top of the image so I can continue to keep these updates weird.)

—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 Tuesday to the ReadMe Changelog) where we provide an overview of the product updates that went out as part of our new Tuesday release cycle. As we refine our format and process for providing these updates, we'd love to hear what you think at [email protected]!