Owlet Weekly Update (Week of July 6th)
Happy Tuesday folks! This edition of the Owlet Weekly Update is dedicated to my mother, who is celebrating her birthday today. π Feel free to tweet at us with your birthday shoutouts using the hashtag #happybirthdaykanadsmom!
We have some exciting updates to our API Explorer, our Suggested Edits workflow, and lots more. Details below! ππ½
Bigger Feature Updates and Improvements
- Building off our Cookie-filled announcement from a few weeks ago, the API Explorer now supports Cookie Authentication! (See a demo here.) πͺ
- Say goodbye to broken links when you change slugs in ReadMe! π Now, when you update the slug on a Guides or API Reference page, links to the old slug will magically redirect to the new slug! β¨
- This wouldn't be a true Owlet Weekly Update without a mention of our massive Search improvements! We're continuing our gradual (emphasis on gradual) rollout to even more projects. As always, we'd love to hear your feedbackβlet us know at [email protected]! π
- Suggested Edits is one of my favorite features within ReadMe. If youβre anything like me when reviewing suggested edits, your review process generally entails reading the raw Markdown diff in the suggestion, closing your eyes, and imagining what these changes look like in the documentation. π Well Iβve got wonderful news for those of you that donβt share my vivid imagination. Suggested Edits now has a Preview button! π
Bug Fixes and Minor Improvements
- A few weeks ago, we fixed a bug where users were unable to save their changes when making edits in Raw Mode. Turns out this was an issue with the Custom Pages as well. Happy to report that it's now fixed! π
- Now that data actually loads in Documentation Metrics, we discovered another bug where clicking to see additional info wouldn't even load that data. Sorry about that, folks. This issue has now been fixed! π₯
- Fixed an issue with our Segment Analytics integration where, for certain projects, it was only tracking initial page loads. π
- A small portion of projects may notice some speed improvements during the initial load of the ReadMe project dashboard. π
- Various security and access improvements for projects that use both SAML and ReadMe login. π
- Improvements to how our API Explorer code snippets handle
application/x-www-form-urlencoded
payloads. π¦ - Minor styling improvements to our
api
code snippets in the API Explorer. π - Even more backward-compatibility improvements to the ReadMe Markdown engine. βͺ
Thanks again for reading and for being a part of the ReadMe community (and happy birthday mom)!
βKanad and the ReadMe Team
What is the Owlet Weekly Update?
Thanks for tuning in to another edition of the Owlet Weekly Update βan owlet-sized update (posted every Tuesday to the ReadMe Changelog) where we provide an overview of the bug fixes and minor improvements 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]!