Skip to content

docs: improve notifier configuration#1062

Closed
akramer-zibra wants to merge 1 commit intoArksine:masterfrom
akramer-zibra:master
Closed

docs: improve notifier configuration#1062
akramer-zibra wants to merge 1 commit intoArksine:masterfrom
akramer-zibra:master

Conversation

@akramer-zibra
Copy link
Copy Markdown

This commit changes some misleading and vague formulations about internal apprise tool/package and supported services. Also fixes some typos and text format in the docs text. See: #1061

Changes some misleading and vague formulations about internal apprise and supported services. Also fixes some typos and text format in the docs text.
@Arksine
Copy link
Copy Markdown
Owner

Arksine commented Mar 21, 2026

It is certainly unfortunate that you were confused by the existing notifier documentation. I disagree with your characterization that the docs are "misleading". The notifier component and its associated documentation have been available for several years and this is the first report I have received regarding said docs. Vague? I suppose that is in the eye of the beholder. The docs didn't explicitly describe Apprise as a "library", however they linked to the library. All that said, I'm not opposed to improving and clarifying the documentation.

Upon reviewing your PR, I think we can be more explicit. It does note that Moonraker "uses" the "tool/package" locally, but it doesn't differentiate between the tool and the API Gateway. To clear up any confusion I have pushed a few commits that should make the following absolutely clear:

  • Moonraker leverages the Apprise library
  • The library is installed as a part of Moonraker
  • The version of the library determines what service notifications are available

I made some additional clarifications and added a link to the official apprise documentation in place of the Wiki. I also took the opportunity to bump Apprise to 1.9.8.

@akramer-zibra
Copy link
Copy Markdown
Author

akramer-zibra commented Mar 21, 2026

Sharing is caring. I appreciate your work. Thank you very much. Case closed

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.

2 participants