Customer StoriesReadMe Blog
Back to All
added

Owlet Weekly Update (Week of February 22)

February 23rd, 2021

Hello and happy Pisces season (the best time of the year, according to... nobody), friends! ♓ It's only fair that we ring in the majestic season of the fish with an overly emotional tribute to some code that we deleted this week. We're also shipping support for discriminators (not the kind that you're thinking of, probably) in the API Explorer, as well as several performance and design improvements. Details below! 🐟

✨ New & Improved

  • Great news for you polymorphism enthusiasts out there—this week, we're shipping support for discriminators in the form input that constructs request bodies in the API Explorer! You can see a demo of the functionality here. 🧱
  • This release includes some tweaks to our strategy for initially serving our JavaScript bundles to your users. This means faster page loads when users stumble across your documentation for the very first time (since their subsequent requests are cached most of the time). A performance gain is a performance gain, folks—no matter how specific! 🏁
  • We've given the API log a new paint job (both in the hub and dashboard)! Now it's easier than ever to view the request and response info and to share the log with others. Curious to see the new look? Check out a sample log here! 🎨
  • Slight design tweaks to get our Changelog title headers in line with other sections—can you notice the difference? ☝️

🛠 Fixes & Updates

  • As alluded to above, we’re parting ways with the old code that originally fueled the flame of our beloved API Explorer. I won't mince words here, y'all: this code walked so our current React component could run. This legacy code has remained a thorn in our sides (and in our hearts ❤️) for several years now while our current React component implementation has been running the show. While this code removal won't provide any material improvements to your reference documentation experience, we hope you keep those 3,980 lines of code in your thoughts during this difficult time. 🕯️
  • Some developments in the global conversation surrounding callout culture: this time in the form of tiny padding fixes for lists within Markdown callouts. (Related, but not really: adrienne maree brown recently came out with a book on the topic!) 🗣️
  • Minor URL fixes for Suggested Edits in the dashboard. 🔗

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