Skip to content

Commit

Permalink
Add December 2024 newsletter (#340)
Browse files Browse the repository at this point in the history
Feedback and suggestions welcome!


<!-- readthedocs-preview readthedocs-about start -->
----
πŸ“š Documentation preview πŸ“š:
https://readthedocs-about--340.org.readthedocs.build/

<!-- readthedocs-preview readthedocs-about end -->

---------

Co-authored-by: Manuel Kaufmann <[email protected]>
  • Loading branch information
ericholscher and humitos authored Dec 11, 2024
1 parent 133e888 commit d28546a
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 2 deletions.
Binary file added content/images/december-2024.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions content/posts/newsletter-december-2024.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
title: Read the Docs Newsletter - December 2024
date: December 11, 2024
description: Company updates and new features from the last month, current focus, and upcoming features.
category: Newsletter
tags: newsletter, community
authors: Eric Holscher
status: published
image: /images/december-2024.jpg
image_credit: Photo by <a href="https://unsplash.com/@thebeardbe?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Filip Bunkens</a> on <a href="https://unsplash.com/photos/road-covered-by-snow-near-vehicle-traveling-at-daytime-R5SrmZPoO40?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Unsplash</a>

## News and updates

* **Our new dashboard is now the default for all users.** This has been a long time coming, and we are excited to have have everyone migrated over. The old dashboard will be [removed on Mar 11th](https://about.readthedocs.com/blog/2024/11/rollout-of-our-new-dashboard/).
* **[Link Previews](https://docs.readthedocs.io/en/stable/link-previews.html)** are now available in Addons. This feature allows you to see a preview of the linked page when you hover over a link in your documentation. This is a re-implementation of our [Sphinx extension](https://sphinx-hoverxref.readthedocs.io/) that works for any documentation tool.
* We're adding additional documentation examples for documentation tools that are supported on Read the Docs. This month we added [Docusarus](https://docs.readthedocs.io/en/stable/intro/docusaurus.html) and [Markdoc](https://docs.readthedocs.io/en/stable/intro/markdoc.html).
* All of our ``build.tools`` were [updated to their latest versions](https://github.com/readthedocs/readthedocs.org/pull/11742).
* We added support for [longer environment variables](https://github.com/readthedocs/readthedocs.org/pull/11748), which some users were running into limits on.

You can always see the latest changes to our platforms in our [changelog πŸ“ƒ](https://docs.readthedocs.io/page/changelog.html).

## Upcoming changes

* We are working to allow extending default ``build.jobs`` in the new build system. This will allow you to customize the build process more easily, with things like ``build.jobs.build.pdf`` being able to override the PDF build. This is now built, and we're testing it internally before documenting it publicly.
* We are planning to move our official documentation to https://docs.readthedocs.com to make it more obviously official. This should be a seamless transition for users, but we will be updating links in our documentation and on our website to reflect this change.

Want to follow along with our development progress? View our [development roadmap πŸ“οΈ](https://github.com/orgs/readthedocs/projects/156/views/1)

## Possible issues

* [Deprecation and removal of embed API v2](https://about.readthedocs.com/blog/2024/11/embed-api-v2-deprecated/). It will be removed on **January 20, 2025**. Please update your integrations to use the new Embed API v3.

-----

Questions? Comments? Ideas for the next newsletter? [Contact us](mailto:[email protected])!
4 changes: 2 additions & 2 deletions content/posts/newsletter-november-2024.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ image_credit: Photo by <a href="https://unsplash.com/@hermanndoyo?utm_content=cr

* The new **Community dashboard** at https://app.readthedocs.org will be made the default dashboard on November 12. We are still beta testing the Business dashboard, as it effects documentation authentication and requires a bit more testing. We expect to make the Business dashboard the default soon.
* We've added **multi-factor authentication (MFA)** to our platform, and it's now fully released. Give it a try to add an extra layer of security to your account.
* We have added **Python 3.13** as a build option, along with `updating other build tools <https://github.com/readthedocs/readthedocs.org/pull/11742>`_.
* We have added **Python 3.13** as a build option, along with `updating other build tools <https://github.com/readthedocs/readthedocs.org/pull/11742>`_.
* **Addons** continues to get iterative improvements, including allowing more granular configuration of `documentation notifications <https://docs.readthedocs.io/en/stable/doc-notifications.html>`_, and fixing bugs in the injection logic for large images.
* Our **file tree diff** feature is now in testing, and will be rolled out into Addons in the near future. This will allow you to see what files have changed between versions of your documentation.
* Similarly, **quick previews** when you hover a link is now in testing for Addons, and will be released soon. This will allow you to see a preview of the linked page when you hover over a link in your documentation.
* Similarly, **link previews** when you hover a link is now in testing for Addons, and will be released soon. This will allow you to see a preview of the linked page when you hover over a link in your documentation.

You can always see the latest changes to our platforms in our [changelog πŸ“ƒ](https://docs.readthedocs.io/page/changelog.html).

Expand Down

0 comments on commit d28546a

Please sign in to comment.