Docs: Dissolve former handbook, and establish "Notifier catalog" instead

mqtt-tools · Apr 15, 2023 · b15511c · b15511c
1 parent 0c326a3
commit b15511c
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 22 deletions.
diff --git a/docs/configure/index.rst b/docs/configure/index.rst
@@ -8,6 +8,9 @@ This part of the documentation covers the configuration of mqttwarn. The second
 step to using any software package after its :ref:`installation <installation>`,
 is getting it properly configured. Please read this section carefully.
 
+To directly jump to the corresponding sections, visit
+:ref:`mqttwarn.ini`, :ref:`services`, :ref:`topics`, and :ref:`transformations.
+
 
 ******************************
 Application configuration file

diff --git a/docs/handbook.md b/docs/handbook.md
diff --git a/docs/index.rst b/docs/index.rst
@@ -70,10 +70,6 @@ documentation carefully.
 
 - :ref:`Install and operate mqttwarn <use>`
 - :ref:`The mqttwarn configuration <configure>`
-
-Previous documentation and documentation currently being migrated:
-
-- :ref:`handbook-old`
 - :doc:`README <readme>`
 
 
@@ -116,8 +112,8 @@ the MQTT specifications.
 
    usage/index
    configure/index
+   notifier-catalog
    README <readme>
-   handbook
 
 .. toctree::
    :maxdepth: 2

diff --git a/HANDBOOK.md → docs/notifier-catalog.md b/HANDBOOK.md → docs/notifier-catalog.md
@@ -1,21 +1,7 @@
-(handbook-old)=
-# Old handbook (phasing out)
-
-
-:::{important}
-We are currently reworking the documentation, so this document is
-gradually being phased out.
-
-Please head over to https://mqttwarn.readthedocs.io/.
-:::
-
-
-## Configuration
-See [mqttwarn.ini](#mqttwarn.ini), [](#services), [](#topics), and [](#transformations).
-
 (notification-services)=
 (services-catalog)=
-## Notification service catalog
+(notifier-catalog)=
+## Notifier catalog
 
 _mqttwarn_ supports a number of notification services. This list enumerates them
 alphabetically sorted.