-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Post: Empower your documentation with addons
Initial draft
- Loading branch information
Showing
2 changed files
with
69 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
title: Empower your documentation with addons | ||
date: 2024-03-27 | ||
category: Changelog | ||
tags: addons, hosting | ||
authors: Manuel Kaufmann | ||
status: published | ||
image: /images/enable-beta-addons.jpg | ||
image_credit: Photo by <a href="https://unsplash.com/@impatrickt?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Patrick Tomasso</a> on <a href="https://unsplash.com/photos/open-book-lot-Oaqk7qqNh_c?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Unsplash</a> | ||
|
||
|
||
In the last year, we have been focusing ourselves on providing a better experience to readers of the documentation. | ||
Today, we are thrilled to introduce our latest feature, | ||
designed on top of feedback from readers to build a better experience for them in our platform: Read the Docs Addons. | ||
|
||
|
||
## Full list of addons | ||
|
||
<!-- | ||
TODO describe each of the addons into its own section, | ||
similar to what we have in https://github.com/readthedocs/addons/blob/main/README.md | ||
Consider also https://about.readthedocs.com/docs-as-code/ | ||
--> | ||
|
||
### Analytics | ||
### DocDiff | ||
### Pull request notification | ||
### Flyout | ||
### Non-stable notification | ||
### Latest version notification | ||
### Search as you type | ||
### Sponsorship | ||
|
||
## How to enable addons in your project | ||
|
||
To enable Read the Docs Addons in your project follow these steps: | ||
|
||
1. Go to the [new beta dashboard](https://beta.readthedocs.org). | ||
1. Click on the project you want to enable addons. | ||
1. Go to **Settings**, then **Addons (Beta)** from the left bar. | ||
1. Check **Enable Addons**. | ||
|
||
Now you have Read the Docs Addons enabled, | ||
readers of your project's documentation can start using these features. | ||
|
||
## Moving forward | ||
|
||
We have implemented Read the Docs Addons in a modular way that allows us to expand them in the future. | ||
There are plans to keep adding more addons to this list and also re-implement some of the Sphinx extension we've created in the past | ||
(e.g. [`sphinx-hoverxref`](https://github.com/readthedocs/sphinx-hoverxref)) as an addon, | ||
making it compatible with non-Sphinx projects. | ||
We are also open to suggestions for new addons! | ||
|
||
## Conclusion | ||
|
||
Read the Docs provides a lot of feature for documentation authors to simplify their workflow to keep the documentation updated, | ||
providing pull request previews, automatition rules, versioning, translation, and many other features. | ||
|
||
The introduction of Read the Docs Addons, empowers the readers experience as well, closing the circle between authors and readers. | ||
Addons gives readers a quick way to find what they are looking for, | ||
notifies them about reading the _latest_ version which may have features that are not yet implemented or, | ||
an old version that may be deprecated, | ||
gives them a way to quickly switch between versions and translations of the same page, | ||
and much more in near future! | ||
|
||
## Contact | ||
|
||
[Contact us](https://readthedocs.org/support/) if you have any questions about the new beta Read the Docs Addons, | ||
or [open an issue](https://github.com/readthedocs/addons) to share any feedback you may have. |