POC addons listing

readthedocs · Jul 1, 2024 · dbb6482 · dbb6482
1 parent a5e720a
commit dbb6482
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 5 deletions.
diff --git a/docs/user/addons.rst b/docs/user/addons.rst
@@ -0,0 +1,24 @@
+Read the Docs Addons
+====================
+
+**Read the Docs Addons** is a group of features for documentation readers and maintainers that you can add to any documentation set hosted on Read the Docs:
+
+- :doc:`Traffic analytics </analytics>`
+- :doc:`DocDiff </pull-requests>`
+
+Enabling Read the Docs Addons
+-----------------------------
+
+All projects using the `build.command` :ref:`build command <config-file/v2:build.commands>` are already using the Addons, other projects can enable them by following these steps:
+
+#. Go to the new beta dashboard:
+
+    * `Community <https://beta.readthedocs.org>`_
+    * `Business <https://beta.readthedocs.com>`_
+
+#. Click on a project name.
+#. Go to **Settings**, then in the left bar, go to  **Addons (Beta)**.
+#. Check **Enable Addons**, or enable Addons individually.
+
+
+
diff --git a/docs/user/analytics.rst b/docs/user/analytics.rst
@@ -1,8 +1,7 @@
 How to use traffic analytics
 ============================
 
-In this guide, you can learn to use Read the Docs' built-in traffic analytics for your documentation project.
-You will also learn how to optionally add your own Google Analytics account or completely disable Google Analytics on your project.
+This guide covers traffic analytics for your documentation project, either built-in or provided through Read the Docs Addons. You can also learn how to enable or disable Google Analytics.
 
 Traffic Analytics lets you see *which* documents your users are reading.
 This allows you to understand how your documentation is being used,
@@ -35,8 +34,8 @@ Enabling Google Analytics on your project
 Read the Docs has native support for Google Analytics.
 You can enable it by:
 
-* Going to :guilabel:`Admin` > :guilabel:`Settings` in your project.
-* Fill in the **Analytics code** heading with your Google Tracking ID (example `UA-123456674-1`)
+#. Going to :guilabel:`Admin` > :guilabel:`Settings` in your project.
+#. Fill in the **Analytics code** heading with your Google Tracking ID (example `UA-123456674-1`)
 
 .. figure:: /_static/images/google-analytics-options.png
    :width: 80%

diff --git a/docs/user/index.rst b/docs/user/index.rst
@@ -22,6 +22,7 @@ Read the Docs: documentation simplified
    /config-file/v2
    /automation-rules
    /guides/reproducible-builds
+   /addons
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/user/pull-requests.rst b/docs/user/pull-requests.rst
@@ -28,7 +28,15 @@ Warning banner
     A warning banner is shown at the top of documentation pages
     to let readers know that this version isn't the main version for the project.
 
-    .. note:: Warning banners are available only for :doc:`Sphinx projects </intro/getting-started-with-sphinx>`.
+    .. note:: Warning banners are available only for :doc:`Sphinx projects </intro/getting-started-with-sphinx>` or projects using :doc:`Read the Docs Addons </addons>`.
+
+DocDiff
+    DocDiff shows proposed changes by visually highlighting the differences between the current pull request and the latest version of the project's documentation.
+
+    Press ``d`` to toggle between DocDiff and normal pull request preview.
+
+    .. note:: DocDiff is available only for projects using :doc:`Read the Docs Addons </addons>`.
+
 
 .. seealso::