mqtt-tools / mqttwarn

A highly configurable MQTT message router, where the routing targets are notification plugins, primarily written in Python.
https://mqttwarn.readthedocs.io/
Eclipse Public License 2.0
955 stars 183 forks source link

Bring documentation to Read the Docs #636

Closed amotl closed 1 year ago

amotl commented 1 year ago

Hi,

coming from https://github.com/jpmens/mqttwarn/issues/389#issuecomment-1504209613, I've finally made a start on publishing a rendered version of the documentation.

The previous single-page HANDBOOK.md has grown to almost 4000 lines, and became unbearable. It has been dissolved now.

The three main pillars of documentation, where most content has been refactored to, are "Services", "Topics", and "Transformations" now, resembling the very core of mqttwarn. You will find them at the "Configuration" section of the documentation ^1. On the other hand, the grand catalog of notifier plugins is now on a dedicated page ^2, and it's still single-page, because tearing it apart would also be unbearable.

While working on the refactoring, I've diligently edited each and every piece of text I've actually moved, applying spring-cleaning-like tasks, and adjusting phrasing and wording towards active voice. The same kind of editing should also be applied to the single-page notifier catalog, which has been moved over verbatim. However, I will not have the capacity for that right now, so I am postponing it to a subsequent iteration.

The documentation can be explored at https://mqttwarn.readthedocs.io now. Enjoy.

With kind regards, Andreas.