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!

2720

✨ 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 :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 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. 🧹
400

This documentation category does not spark joy.

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

💔

Kiss me hard before you go
Summertime sadness
I just wanted you to know
That baby, you the best

—Lana Del Rey (but also me, referring to smorgasbord of silverware I've accumulated since college that I finally got rid of in favor of an actual matching set)

2720

"Alexa, play every possible sad song about the end of summer ever."

Change is ripe in the air on the first day of September, folks! Not only in the crisp fall weather here in Minneapolis (that's doing an absolute number on my nasal passages 🤧), but also within ReadMe itself—a new Ruby integration for API Metrics, performance improvements, and so much more. Details below! 🍁

✨ New & Improved

  • Rubyists—rejoice! We just released a Ruby integration for API Metrics that supports Rails and Rack frameworks. Huuuuge thanks to our friends over at thoughtbot for their incredible work on this! Check out the setup docs here. 💎

    And for those keeping score, we now have API Metrics SDKs for Cloudflare (via a Cloudflare Worker), Node.js, PHP, Python, AND Ruby. Hyah! Don't see your language/framework listed? Drop us a line at [email protected]! 🤝
  • General performance improvements in the developer hubs and the API Metrics dashboard. 🚀
  • New date and date-time pickers in the API Explorer. 📆

🛠 Fixes & Updates

  • When previewing a hidden API Reference section in ReadMe, you'll often see a little button labeled "Enable it for everyone" that, as the name suggests, takes you to a location in the dashboard where you can enable the API reference section for everyone. Unfortunately, what the name of the button suggests and what it actually did were two slightly different things. Now, they're the same! Love that. 👯
  • If you've ever used ReadMe during a trial period, you'll know that we occasionally inform you of features that you're using that are only available for paid subscriptions. Well, for a small chunk of customers, that popup would appear for... wait for it... people that are on paid subscriptions. Oops! Happy to report that this release includes a fix to this bug/deceptive marketing tactic. 💸
  • Various API Explorer fixes related to authorization keys and polymorphism.
  • Minor fixes to the ReadMe Markdown engine's compatibility mode. 🧓
  • Tiny behind-the-scenes error handling improvements. 🤓
  • Small stability improvements to our sidebar. 🍫
  • A couple of small security fixes. 🔐

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

—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 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)! :owlbert-books:

✨ New & Improved

A cat uploading a hamburger to the internet—so as to visualize file uploading for the sake of this feature announcement.
  • 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 :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 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 :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 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?)! 🗳️

2720

*sigh of relief*

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

🏃

Independent, athletic.
I been sweating, doing calisthenics.
Booty vicious, mind yo business.
I been working, working on my fitness.

—Lizzo, and all of us at ReadMe that completed a month-long step challenge AND participated in a 5K over the weekend 💦

2720

Seriously... what happened to July?

Happy Tuesday (and happy August... already?) folks! Our bodies aren't the only vessels that drastically improved their health and performance outcomes in the last week—more details below!

✨ New & Improved

  • Big improvements to our crawler (used for our search engine) in the performance and stability departments. 🐛
  • Several small improvements to our Markdown engine now that we've boarded the SSR train. 🚋
  • Behind the scenes, we’ve been working on improvements to our core architecture, which will greatly improve our development workflow, and the ReadMe experience as a whole! Stay tuned. 🚀

🛠 Fixes & Updates

  • Look y'all, I'm just going to say it—people with uppercase letters in their email address deserve to be treated like the rest of us. And for those of you trying to access enterprise projects via SAML login, that wasn't the case—there was a bug that prevented you from receiving access in certain cases. Not cool. Happy to report that this has been fixed. ✉️
  • There was a tiny bug where users were unable to properly configure default array values in the manual API editor. With this release, you can now do so with ease. 🔧
  • Additional fixes for other instances of the caching issue that we discovered last week in the reference guides. 🕺🏽
  • A couple of small fixes to our new search modal, including how it filters search results across projects. 🔍

Be sure to check out our latest Instagram post for some pics from our virtual team 5K in support of COVID-19 relief! And as always, thanks for reading and for being a part of the ReadMe community.

—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 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 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! ♌️

2720

These weekly updates are a big enough deal now that we got a graphic made. Leo energy, y'all. ♌️

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

- Welcome to the Owlet Weekly Update for the Week of July 13!
+ Welcome to the Owlet Weekly Update for the Week of July 20!

Another week, another weekly update! This week's release bore many small fruit, including diff language support in our code blocks (as demonstrated above), fixes to several glaring spelling and grammatical errors, and many other small improvements and fixes. Read on for the details! 🍓

✨ New & Improved

  • As part of our *ahem* massive Search improvements, did you know that you can trigger the new Search modal on any page by pressing + K on macOS or ^ + K on other platforms (e.g. Windows, Linux)? Well for those of you that fall in the latter category, that's been a bit confusing thus far since the search bar previously indicated that it was + K for all platforms. Happy to report that we render the Command or Control key based your platform. 💻
  • A couple of small design touch-ups, primarily to ensure our icon updates from last week are reflected everywhere. 💄
  • Added support for diff syntax highlighting in our code blocks. 🎨
  • Our rdme command line tool now takes advantage of our improved API error responses. 🚀
  • Responsive polish in the guides and reference sections. 📱
  • We gave the Owlbert emoji a new look! :owlbert: You can use it by typing :owlbert: into your docs. If you haven't already, check out our ReadMe Markdown docs for more info.

🛠 Fixes & Updates

  • As you may have heard last week, we made some huge improvements to the ReadMe API, including a link to an API log in every error response! We noticed issues with how our API logs were constructing sample cURL for certain requests (as well as a few spelling errors in our API error poems). This release includes some major reliability improvements to our API logs, as well as some desperately-needed fixes to the spelling errors. 🖋️
  • Fun fact: Log In is a verb, whereas Login is a noun. And turns out we've had that mixed up in some of our copy for... probably years. This was probably bugging many of you grammar nerds (including our very own Copy Queen, Shinae—thanks for the catch!). We appreciate your restraint and the lack of Twitter callouts. 🤓
  • There was a tiny issue on certain pages in the Enterprise project dashboard where we were displaying black text on a black background. Turns out that severely limits one's ability to write Custom CSS and JavaScript. Please rejoice — this has been fixed and you can now view your own code! 🧑‍💻
  • As part of our addition of diff syntax highlighting, we noticed a little quirk where switching between certain languages in the code editor may not actually update the code's syntax highlighting correctly. This release also includes a fix to that. 🔄
  • Various small improvements in the API Explorer, including better support for default in the OpenAPI Responses object and minor fixes to how we handle x-www-form-urlencoded payloads. 📦
  • Fixed a bug in the Manual API Editor where defining default values wouldn't be reflected in the API reference section. ✏️
  • Several minor security fixes including to an issue where changes to a user's project permissions weren't immediately taking effect in their current session. 🔐
  • Minor clean-up in the API error response objects that we updated last week. 🧹

Thanks again for being a part of the ReadMe community!

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

🎉

Welcome to another update!
We have exciting news to share.
This week, we updated the ReadMe API
To include poems with every err'!

Alas, I'm not nearly as good at writing poems as Greg (our CEO) is — who literally wrote over 30 unique poems for each and every error code that is returned from the ReadMe HTTP API! 🖋️

In other non-poetry-related (but nevertheless exciting) news, we also shipped some exciting updates to our icons, made a ton of usability improvements to our GitHub integration, and lots more. More information below! :owlbert-reading:

✨ New & Improved

  • As mentioned above, we made some huge improvements to our API errors. Now, when you receive an error from the ReadMe HTTP API, the response object will include links to API logs, better descriptions of the error, and of course... a poem! 🖋️ Try sending the following cURL request in your terminal and observe the response:

    curl --location --request GET 'https://dash.readme.com/api/v1' \
        --header 'Authorization: Basic T3dsZXQgV2Vla2x5IFVwZGF0ZTo='
    
  • This hopefully won't be nearly as controversial as the great Slack logo change of January 2019 (we ALL had opinions on that), but we gave some of our icons a fresh redesign! Our design team wanted to create a set of icons that are simpler, more consistent, and that hopefully feel more relevant to the use case (it's an API Reference section, not an audio mixer!) — check out the changes below and let us know what you think. 🎨

1500
  • If you were following our Changelog this past Halloween, you'll recall that we shipped a GitHub integration in large part because we wanted to share this image. While I don't have any culturally relevant images to share this time around (and honestly if I did, they'd be quite bleak), I'm excited to announce some big improvements to our GitHub Action: A beautiful new onboarding flow in the dashboard and a vastly simplified workflow configuration file! Check out our updated article in the docs for more info. 🎃
  • We're so close to the end of this gradual rollout of our new search feature y'all... So close! We just did an additional rollout of these search improvements to even more projects today. If you haven't already, please let us know what you think at [email protected]! 🔍

🛠 Fixes & Updates

  • With the announcement of ReadMe Free, we've seen a lot of new interest — which has been very exciting! However, there was a bug where if you selected the Free plan, it was impossible to switch back to your trial. We also added some in-product clarification about what features are available during the trial versus in the Free plan. You can also check out our pricing page for information on this. Apologies for any confusion, folks! Happy to report that these fixes and clarifications are now live.
  • In addition to better error messages, we made our API a bit smarter with respect to Basic Authentication. While we still recommend using best practices for Basic Auth, we'll do our best to recognize other ways you send us your credentials in the Authorization header. 🔐
  • For those of you that were agonizing over our glaring lack of icon support for HEAD and TRACE requests in the API Explorer — rejoice! We've just added them. 🎨
  • Most ReadMe project administrators are only members of one or two projects — but for you power users out there, we made some minor readability improvements to the dashboard project list view. 👀
  • Minor rendering improvements related to our newly redesigned project navigation bar. 🧭
  • A couple of tiny design fixes to our new search feature. 🔍
  • And last but definitely not least, some big behind-the-scenes improvements to our release process (which makes my job so much easier — thank you Rafe)! 🚀

Thank you for reading another weekly post,
Thank you for bearing with me as I do the most,
And thank you for being a part of the ReadMe community—
Check out this Code Switch episode on qualified immunity.

—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 Tuesday to the ReadMe Changelog) where we provide an overview of 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]!