Skip to content

Latest commit

 

History

History
96 lines (64 loc) · 5.63 KB

newsletter-april-2023.rst

File metadata and controls

96 lines (64 loc) · 5.63 KB
Raw
.. post:: April 7, 2023
   :tags: newsletter, python
   :author: Ben
   :location: MLM
   :category: Newsletter

Read the Docs newsletter - April 2023

News and updates

  • 📚️ Over the past ~6 months, we gradually refactored our user documentation to align with the Diátaxis Framework. The results are now manifested in the structure of the navigation sidebar and the landing page on docs.readthedocs.io.
  • 📊️ All of our websites now use Plausible for analytics.
  • ⚙️ Added a new build variable READTHEDOCS_CANONICAL_URL that's useful for projects that need the canonical base URL while building. View docs.
  • ⚙️ Added new build variables READTHEDOCS_GIT_CLONE_URL, READTHEDOCS_GIT_IDENTIFIER, and READTHEDOCS_GIT_COMMIT_HASH for projects that need to access Git data while building. View docs.
  • 🔒️ Fixed vulnerability: Cache poisoning: serving arbitrary content on documentation sites

You can always see the latest changes to our platforms in our :doc:`Read the Docs Changelog <readthedocs:changelog>`.

A screenshot of our current documentation after the refactor

A screenshot of how our user documentation looks in April 2023.

Upcoming features

  • 📚️ We are still doing changes in our user documentation structure and content: Once the last parts of the plan are implemented, we are ready to share a bigger announcement.

  • ⚡️ A lot of work is happening these days on big front-end features. In :doc:`the last newsletter </newsletter-march-2023>`, we mentioned the new Dashboard and :doc:`the migration to about.readthedocs.com </website-migration>`. What's new is that we've also started building a generic JavaScript client accompanied with APIs that will give additional features to any documentation project or static site built and served on the Read the Docs platform.

    The first proof-of-concept for the new API and JavaScript library has been test-driven. It is capable of displaying a menu matching our current :doc:`flyout menu <readthedocs:flyout-menu>` and :doc:`integrated server side search <readthedocs:server-side-search/index>`.

    The new library is useful for any documentation framework or static site generator to allow for full control of the new flyout menu, integrated search and general access to API data. See the screenshot further down where the integrated search in action on the documentation framework Docusaurus.

    We plan to be rolling this out gradually for Sphinx and MkDocs projects that are currently running their own set of build.commands. Once that happens, we'll be back with news on the blog and documentation about how you can configure it.

A screenshot of the upcoming search dialogue running on Docusaurus

Our proof-of-concept for the JavaScript client is going well! In the screenshot, you can see how the generic Read the Docs search indexing works and how a generic search dialog gives the documentation project additional super powers ⚡️

Want to follow along with our development progress? View our full Roadmap 📍️

Awesome project of the month

Crate.io has integrated 15 Sphinx projects in the same website experience and written their own theme. So they rightly deserve to be this month's addition to Awesome Read the Docs Projects 🕶️. See the highlights in the following Twitter thread or Mastodon thread:

A recent addition to our list of awesome projects 🕶️: @crateio @crateio combines multiple documentation projects into the same website experience.

Oh, by the way, the @crateio docs will turn 10 years old in July 🎂️https://t.co/4cQMj3SNx6

Here is a 🤏 (small) 🧵 pic.twitter.com/tqP1dH5czb

— Read the Docs (@readthedocs) April 4, 2023

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