Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bring documentation to Read the Docs #636

Merged
merged 36 commits into from
Apr 18, 2023
Merged

Bring documentation to Read the Docs #636

merged 36 commits into from
Apr 18, 2023

Conversation

amotl
Copy link
Member

@amotl amotl commented Apr 13, 2023

Hi,

coming from #389 (comment), 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.

Footnotes

  1. https://mqttwarn.readthedocs.io/en/latest/configure/

  2. https://mqttwarn.readthedocs.io/en/latest/notifier-catalog.html

@amotl amotl mentioned this pull request Apr 13, 2023
@amotl amotl marked this pull request as ready for review April 18, 2023 21:29
Base automatically changed from collab/frigate to main April 18, 2023 22:39
@amotl amotl merged commit 079ceeb into main Apr 18, 2023
@amotl amotl deleted the amo/readthedocs branch April 18, 2023 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant