Read the Docs newsletter - October 2022

September was exciting because a few members of our team finally got to gather in person. Manuel, Benjamin, and Eric all attended Djangocon Europe in September, and had lots of great discussions around documentation.

Also, as we mentioned, in Q4 we’re going to be focusing on our core platform features. This means we’ll have fewer new features to talk about, but lots of smaller improvements to the overall experience of using Read the Docs.

New features

The latest updates from our team:

  • We fully rolled out support for auto-cancelling running builds when a user does multiple pushes to a branch in a small window of time. We wrote up a full post on the blog about it, where you can read more.

  • Redirects can now be edited directly in our dashboard. This was an oversight that we are glad to have finally fixed the UX around.

  • We fixed the bug we had previously mentioned around Gitlab tokens expiring. This caused PR builds for these users to stop properly reporting status. If you login with Gitlab again on our service, they will continue working indefinitely now.

You can always see the latest changes to our platforms in our Read the Docs Changelog.

Upcoming features

Our roadmap hasn’t progressed too much from last month, and we continue to focus on these core platform upgrades:

  • We’re working on improving our integration with Material for MkDocs, which is a great theme for MkDocs documentation projects.

  • Many improvements to our URL handling code, which will allow us to support more flexible URL configurations for projects.

  • A search redesign to make it nicer across our dashboard and in-doc search experiences.

Possible issues

We continue planning to be more active in deprecating old and outdated approaches to using our platform in Q4. We don’t have anything firm to announce here yet, but we do plan to be more active in removing these features in the coming months.

We continue to actively deprecate jQuery from our code, as well as guide the Sphinx ecosystem through the transition.

Tip of the month

This month’s tip comes from our Twitter account:

Considering using Read the Docs for your next documentation project? Check out our documentation to get started!

Questions? Comments? Ideas for the next newsletter? Contact us!