Read the Docs newsletter - September 2022

Our focus for August has continued to be around marketing and community outreach. We continue to better understand how our customers view our product, and work with them to use it well.

We’re working to establish our goals for Q4 2022, and it looks like continued focus on polishing core platform features. We have a lot of features, and we need to continue making them easier to use.

New features

The latest updates from our team:

  • 🎉 We have soft launched the initial version of our new landing pages and started sharing it with the community. We plan to eventually have this as our primary landing page once we’ve gotten more feedback on it.

  • We have improved out logic for cancelling builds when a commit is pushed to an already building version. This will improve user experience waiting on a build that will be overwritten, and save our servers some time as well!

  • We continued improving our docs pages. This month we did badges & build troubleshooting.

  • A lot of work has continued to standardize our codebase on the djstripe package, instead of our own custom stripe webhook implementation.

  • We improved our custom domain handling so that users who haven’t properly activated their domain will get reminded about it a few times, and then we’ll stop trying to configure it.

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

Upcoming features

  • We continue to work on improvements to our URL handling code, which will allow us to support more flexible URL configurations for projects.

  • We are working to redesign some of our search to make it nicer across our dashboard and in-doc search experiences.

  • Our telemetry data is starting to really come together, and we’re gathering insights on interesting metrics around builds. Expect a few blog posts about this in the coming months.

  • The 1.1 release of our sphinx_rtd_theme had a large amount of work done, and is nearing release.

Possible issues

We have been having an ongoing issue with our Gitlab integration, where we can’t refresh OAuth tokens for users. This has caused GitLab integration to randomly break after users enable it. We believe we have found a fix for this, which will be deployed soon.

We are 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!