Welcome to another Owlet Weekly Update! I'm going to state the obvious here folks—we all learn best when we learn by example. And there's no better example right now than this week’s Owlet Person of the Week (which is totally a thing, trust me)—American men’s basketball player LeBron James! In honor of Mr. James and the example he sets for all of us, we’ve added response examples to the API Explorer. Read onward for details on this and so much more! 🏀

✨ New & Improved

• As alluded to above, we now support defining response examples via the example keyword. What does this mean? You can now create sample API responses that your users can preview before they even hit the “Try It” button! This makes it even easier for your users to know what to expect from your API. See it in action here! 👀
• If you’ve ever brought your OpenAPI/Swagger file into ReadMe, you’ll know that we have a variety of extensions available so you can customize your reference guides to your liking. These properties used to apply to your entire reference section, but why paint with such a broad brush? With this release, you can now specify options at the operation level. Hooray for smaller brushes! 🖌️
• We just made some changes to our knowledge base to make it easier to navigate. Let us know what you think! 🧭

🛠 Fixes & Updates

• What’s a pull request on GitHub without the angry “any update?” comments? Well, ReadMe’s version of pull requests (which most of you know as Suggested Edits) were temporarily unable to load the comments section. Great in theory for preventing abuse, bad in reality for actually conversing with the person that submitted the suggested edit. For better or worse, this release brings the comments section back. 💨
• Did you know that API Metrics uses your OpenAPI definition to help you understand your usage better? For example, when viewing your most popular API endpoints, we group certain URLs together if they share path parameters! With this release, the dashboard will offer some suggestions so you can make the most of your metrics. 📈
• All response examples deserve to be treated fairly… including those that are passed via $ref! Now, we properly render response examples regardless of how they’re referenced. 🔄

Thanks for reading and for being a part of the ReadMe community(and congratulations again to LeBron James on winning Owlet Person of the Week)!

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

Hello and happy October, friends! Thanks for tuning into another Owlet Weekly Update. We still have a lot of folks out and a lot of bigger initiatives that we're working on (stay tuned 👀), but in the meantime—we've got great news for fans of analytics, color, and Migos. Details below! 🎃

✨ New & Improved

• We’ve enhanced our Segment integration to support custom domain proxies—meaning you’ll be able to proxy all your tracking events through your domain. 🌐

🛠 Fixes & Updates

• Much like with the tech industry as a whole, a few customers noticed a little lack of color in their code samples lately. Well while we’re still a part of the fight for a more diverse and inclusive tech industry, (check out our blog post on our interview process and our careers page—QTBIPOC encouraged to apply!) this release includes a fix to our syntax highlighter. Hooray for color! 🌈
• “Offset!” -Offset (also us, adjusting the margins of our new table of contents to better align with the first line of content). 🎨
• Authentication fixes for enterprise projects that use both ReadMe and SAML login flows. 🔐
• “Patched” up the vertical alignment on the PATCH badge. 🏴‍☠️
• Small scrollbar fixes in the dashboard. 🖱️

Once again, thanks for reading and for being a part of the ReadMe community!

—Kanad and the ReadMe Team

Happy Tuesday, folks! We have a lot of folks out this week (but don't worry, we'll wake them up when September ends!) so this update is a bit on the shorter side. Nevertheless, lots of little fixes for our grammar nerds and our legacy users—details below! 👇🏽

🛠 Fixes & Updates

• For those of you ReadMe community members that still exist in the Dark Ages (in other words, you’re still on the legacy version of our platform), you may have noticed issues reordering documentation pages. Thankfully, this release includes a fix for that! Sorry for making the Dark Ages even darker, folks. (If you want to enter the Age of Enlightenment, check out our FAQ on upgrading to our current platform—it’s completely free and our amazing support team makes it super easy to do!) 🏰
• Our image uploader was briefly having trouble loading on legacy projects and in a handful of other places. Should be resolved now—upload responsibly, kids! 🖼
• Some of you may have been completely baffled by the errors you were seeing when creating a new project. This release should quell the bafflement. 💭
• Another week, another discovery of some atrocious typos by our copy queen Shinae. 🤓
• Fixes to some category syncing issues when uploading OpenAPI files. 🔄
• Patches to a couple of tiny design regressions. 🎨
• Small security fixes. 🔐

Thanks, as always, for reading and for being a part of the ReadMe community!

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

Hello hello, welcome to yet another Owlet Weekly Update! This week's fixes were focused on security and reliability, including to the the API Explorer, the Page History feature, and more. Details below!

✨ New & Improved

• Everything’s bigger in Texas—including our limits on how many custom pages you can add to a project. As of this release, at least. Disclaimer: these changes also apply to our non-Texan customers as well. 🤠
• Minor stability improvements when pulling up Page History in the dashboard. ⏳

🛠 Fixes & Updates

• If you’ve ever merged a Suggested Edit into your ReadMe documentation, you may have noticed that the Page History would incorrectly attribute the changes to the creator of the page, rather than the person that merged the Suggested Edit. Well this isn’t Drake’s discography! With this release, content updates are properly credited. 📝
• Like dates (the fruit), our dates (the UI component) didn’t quite sit right with everyone. So, we decided to metaphorically go with an apple and… okay I’ve lost the metaphor here, but what I’m trying to say is… all date and date-time inputs in the API Explorer are string inputs rather than date and date-time picker components. Sorry if your browser was allergic. 🍎
• We released a Ruby SDK for API Metrics a few weeks ago, and with that came some onboarding docs that had some glaring typos—which don’t exactly inspire confidence during an onboarding experience. Thanks to Ruben, who wrote in pointing those out! This release includes some spelling improvements which should hopefully put your mind at ease. 😌
• Looks like some of you kids had a little too much fun… because this release includes a few additional guardrails for our previously mentioned API endpoint for applying for a job with us. Be sure to try it out if you haven’t already done so! 💙
• For those of you that exist on a plane of chaos, our API Explorer is now operating on your level. In other words, our API Explorer file uploader now has support for file names that contain parentheses. 📡
• We did it folks. We’re officially 100% secure now! Just kidding (probably). But this release includes a lot of little security fixes that get us reeeeaaal close. 🔐
• Super tiny fixes to the setup and deployment workflow for Custom OAuth Login. 🚀
• Better support for cyclical references in the API Explorer. 🔁

It's National Voter Registration Day, sodon't forget to register to vote! Thanks again for reading and for being a part of the ReadMe community,

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

Hello and welcome to another Owlet Weekly Update! Question for you—how would you describe the opposite of “death by a million cuts”? I’m thinking... “life by a million snacks”? I’d say that’s an adequate descriptor for this release—lots of small, substantial updates that should speed things up and fix some annoyances. Details below!

📘

Slightly Delayed Release This Week

You may have noticed that this Changelog post was published on a Thursday rather than a Tuesday! Unfortunately, we ran into some last-minute issues with this release. Fortunately, we figured them out. We should be back to our regularly scheduled programming (i.e. our Tuesday release cycle) next week. Thanks for your patience, folks!

✨ New & Improved

• We're working on a bigger initiative to move away from legacy AngularJS code towards a modern front end architecture (pssst... come work with us!) In that vein, we completely rewrote the table of contents (TOC) from the ground up as a server-side-rendered React component, just like our Markdown engine. What exactly does this mean? We now use good, old-fashioned HTML anchor links for scrolling to different sections, and native CSS sticky positioning to pin the TOC to the top of the page, rather than custom legacy AngularJS code. This results in a TOC experience that’s lighter, faster, and more reliable. And the best part? It looks exactly the same. 💖
• This release includes some major server-side performance improvements, specifically in reducing the number of requests to our search index and some general optimizations to our server middleware. What does this mean for you, dear reader? Faster load times for your documentation. We love to see it! 🚀
• At ReadMe, we strongly believe that your documentation should be customized to your users and their needs… even when they tell you to “delete your account.” Previously, project owners had to contact support in order to delete their own projects. This release grants project owners the ability to delete on their own. 🗑
• I’ve said it before and I’ll say it again—even our users of ReadMe Free deserve nice things! Including API access. Well, starting with this release, our dear free users now have full access to the ReadMe API! POST responsibly, folks. 🍻

🛠 Fixes & Updates

• As you may have heard, we recently added an endpoint to the ReadMe API for applying for a job with us! Well, we have an exciting announcement on that front: In the last week, we received about a million new applicants! Just kidding. But seriously, we have since discovered that lots of people want to play around with an API without actually applying for a job. To address this, we’ve added a new dontReallyApply parameter to the API, which, as the name implies, allows you to see the API in action without actually applying. We won’t judge! (But we do see everything you write, so don’t have too much fun with it, kids.) 🧐
• What is this, mid-summer 2019? Prior to this release, some of our emails were still linking to our old Twitter handle (big thanks to Carlton, who kindly wrote in pointing this out!). Last year, we spent an undisclosed amount of money to obtain the @readme Twitter handle and we clearly we haven’t been getting our money’s worth. But, this release updates our handle in those emails, so now you have no excuse to not be following us! 📧
• If you post something to your Changelog and it doesn’t show up in search results, does it even exist? Well not that I’m concerned about my readership numbers, but I’m sure you may have noticed that these Owlet Weekly Updates aren’t showing up in search results. Thankfully, we’ve identified the issue and Changelog posts should be showing up in search results again soon. 🔍
• Good news, grammar nerds! Shinae, the official Copy Queen of ReadMe, got to work on our owl facts (i.e. what you see when you load the ReadMe project dashboard) and finally gave them some long-overdue grammatical fixes. Really sorry to those of you that winced at these grammatical disasters every time you loaded the dashboard. 🤓
• So apparently, we were using an outdated shade of ReadMe Blue™ (legal disclaimer: not actually trademarked… yet?) for the little lines inside our ReadMe book logo in the top-left corner of the project dashboard. Did anyone else notice this? Me neither. The good news is our eagle-eyed CEO did and included a fix in this release! 💙

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

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

Happy Wednesday folks! We had an extended holiday weekend off here at ReadMe due to Labor Day, so this week’s update is a tad on the shorter side. This week's release includes Search API improvements, new ways to apply for a job with us, and more. Read on for the details!

✨ New & Improved

• If you’ve read these release notes before, you know all too well that we overhauled our Search experience a couple months back! But some of you have rightfully pointed out that we’ve been neglecting the Search API. Because of this, the Search API has been returning outdated or misleading results due to it using an outdated index. Yikes. Well, good news—the massive Search improvements continue! Like the search experience in the docs, the Search API should now return better, more precise results. 🔍
• It’s an API-driven world, and we’re just living in it, folks. Did you know that you can apply for a job at ReadMe via API? Well, it should be a little bit more obvious now—we just moved our job application endpoints into the official ReadMe API. You can check out the docs here. (But seriously, come work with us!) 👋

🛠 Fixes & Updates

• This one is for my fellow KonMari stans! Previously, it was an ordeal to delete entire categories of pages in ReadMe. We didn’t want folks to accidentally delete categories, so we required them to delete every individual page within a category before they could delete the category itself. Now, when you attempt to delete a category, we give you a very clear warning that all pages within the category will also be deleted before moving forward. Thanks for tuning for this week’s episode of the Life-Changing Magic of Tidying Up Your Documentation Categories. 🧹

In (belated) Labor Day solidarity with workers everywhere,

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

Happy Tuesday folks! With the arrival of Virgo season comes lots of exciting improvements, including the ability to upload files in the API Explorer! ♍

You're probably wondering—how do file uploads relate to Virgo season? Not sure... everyone uploads files to the internet regardless of their chart, but I suppose Virgos triple-check that they have the correct file before uploading? 🤷🏽‍♂️

Read onward for details on this week's release (and rest assured, you won't find any more attempts at astrological references)!

✨ New & Improved

• As mentioned above, our API Explorer now has full support for file uploads! What does this mean? Now, for API endpoints that accept raw file data (e.g. endpoints with format: binary, like this one!), the API explorer will allow you to select a local file and send it to the API! 📡

  This sounds like a simple task but a lot is going on behind the scenes, and this was by no means a small undertaking. Shoutout to our API engineer, Jon, for making it happen! (Psst: we're also hiring another API engineer and also lots of other roles!) 👀

• Saving pages is a foundational part of writing docs—and this release includes some yuuuge performance improvements when saving Guides pages in the dashboard. 🚀

• Great news, Pythonistas! Our Python code snippets in the API Explorer are a little cleaner. 🧹

• Minor error handling improvements in the API Explorer. ⚠️

🛠 Fixes & Updates

• About a month ago, we made some Search improvements to render the keyboard shortcut based on what platform you were on. In a certain cases, it would display a flash of raw Angular code before rendering the proper keyboard shortcut. Sorry for the indecent exposure, folks. Happy to report that this release includes a cloak (of the ng variety—if you know, you know) and we've covered up. 🧥
• If you've ever interacted with an API in ReadMe docs, you've most likely come across our good friend the red asterisk (*), which designates certain parameters as required. Turns out, our friend was getting stage fright and wouldn't show up for certain API parameters in our manual editor. Well, we've given the red asterisk a pep talk and it should show up properly now. 🎭
• When you're on your 14-day trial of ReadMe, you should be able to test-drive all of the features available in our Business plan. As it turns out, for a brief period of time this was not the case—certain features were disabled when looking at your docs when they shouldn't be! Happy to report that we've tore down the (pay)wall. 🧱
• Bad news, Pythonistas. In case you missed the announcement last week, we added a Python SDK for API Metrics! But in doing so, we also had some typos in our code samples. We deeply regret this error and extend our sincere apologies to our Pythonista community. 🐍
• Stability fixes for Custom Login in projects that have API Metrics set up (which you should set up too!) 🧰
• Small fixes to how the API Explorer handles security definitions and node-simple code snippets. 🔐
• Minor versioned URL fixes. 🔗

Thanks again for reading and for being a part of the ReadMe community! And thanks to Jon (again) for taking over for me last week.

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

A bit of a smaller release with some of the engineering team taking some much needed vacation, but we've still got some great new stuff for you this week!

✨ New & Improved

• We released a Python SDK for Developer Metrics! 🐍 It's compatible any framework that uses a WSGI, and you can get it via PyPI:

  pip install readme_metrics

• Improved some logging in our backend to be able to track down some of those pesky 500 errors that a few of you have been seeing. 🔍

🛠 Fixes & Updates

• Fixed some bugs that were causing redirect issues projects that use localization. 🌏
• We're about as tired of it as you might be, but we rolled out another fix to our caching architecture in Cloudflare to fix these pesky issues once and for all. 🤞

That's it for this week! Next weeks is shaping up to be a banger (if I do say so myself), so stay tuned! 👀

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

Happy Tuesday and Happy Election Day to my fellow primary voters (Minneapolis-based fans of the Owlet Weekly Update—wya?)! 🗳️

While electoral promises of change are fraught with anxiety and acrimony, the promise of change that I bring you today is filled with hope and joy—particularly if you regularly write Custom CSS in ReadMe! Details below! 🎨

✨ New & Improved

• We gave the warning callout above the Custom CSS dialog in our dashboard a major update! Previously, this was a warning that informed you that your site's CSS may break, without offering much information on how to avoid this. Now, the callout offers some CSS best practices for styling your documentation that should hopefully put your mind at ease. 😌
• Edge caching... can't live with it, can't live without it—amirite? Now, when you save changes to a document, we automatically purge our edge cache so your users can immediately see your latest and greatest work. 🌤️
• Another Owlet Weekly Update, another mention of our massive Search improvements! Mainly just refreshing our icon set and doing some housekeeping to ensure that everyone is safely migrated over. 🧹

🛠 Fixes & Updates

• This issue is related to an issue from a few weeks ago with black text on black backgrounds—turns out that a black cursor on a black background is also hard to see, and that the inability to see your cursor is also severely limiting. Well, happy to report that you can now see it—curse(?) away! 🖱️
• Fixes to the logic behind the query parameter preview for the select few projects that are still in the preview phase with our new Markdown engine. 🔗
• There were certain vendored JSON content types that the API Explorer was rendering as plain text. This release also includes a fix for this. 📦
• Minor vertical alignment fixes for callouts with no headings. ⬆️

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

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