Skip to content

Add ntfy.publish action to ntfy integration #38725

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

Open
wants to merge 6 commits into
base: next
Choose a base branch
from

Conversation

tr4nt0r
Copy link
Contributor

@tr4nt0r tr4nt0r commented Apr 24, 2025

Proposed change

Adds documentation for ntfy.publish action

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Added a new "Actions" section to the ntfy integration documentation, introducing the ntfy.publish action.
    • Provided detailed information on optional parameters for customizing notifications, including formatting, priority, attachments, and delivery options.
    • Included an example usage snippet and a tip referencing emoji shortcode documentation.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Apr 24, 2025
Copy link

netlify bot commented Apr 24, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit ed85db8
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/680b90bb7aebc900082a905d
😎 Deploy Preview https://deploy-preview-38725--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

coderabbitai bot commented Apr 24, 2025

📝 Walkthrough

Walkthrough

A new "Actions" section, specifically "Publish notification," was added to the ntfy integration documentation. This section explains the ntfy.publish action, providing an alternative to notify.send_message for sending notifications. It includes a detailed table describing optional data attributes for customizing notifications, such as title, message, markdown, tags, priority, click, delay, attach, email, call, and icon. An additional tip about emoji shortcodes was also included. No existing documentation was removed or changed, and no code or public API was altered.

Changes

File(s) Change Summary
source/_integrations/ntfy.markdown Added a new "Actions" section with a detailed description and table for the ntfy.publish action and its data attributes. Included a tip about emoji shortcodes. No removals or changes to existing content.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ntfy Integration

    User->>ntfy Integration: Call ntfy.publish with data attributes
    ntfy Integration-->>User: Notification sent with specified customization options
Loading

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
source/_integrations/ntfy.markdown (2)

106-119: Attribute table is comprehensive
All listed data attributes and their descriptions accurately reflect the service’s capabilities. Consider whether any fields are strictly required (e.g., at least one of message or title) and, if so, annotate them accordingly in the “Optional” column or via a footnote.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~114-~114: A determiner appears to be missing. Consider inserting it.
Context: ... | Set a delay for message delivery. Minimum delay is 10 seconds, maximum is 3 days....

(AI_EN_LECTOR_MISSING_DETERMINER)


104-124: Add a YAML usage example
Including a short YAML snippet demonstrating ntfy.publish in an automation or script would help users get started without jumping to code.

Example snippet:

action: ntfy.publish
data:
  title: "Server Alert"
  message: "CPU usage exceeded 90%."
  priority: high
  click: "https://your-dashboard.local"
🧰 Tools
🪛 LanguageTool

[uncategorized] ~114-~114: A determiner appears to be missing. Consider inserting it.
Context: ... | Set a delay for message delivery. Minimum delay is 10 seconds, maximum is 3 days....

(AI_EN_LECTOR_MISSING_DETERMINER)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fa65d9f and 5e59248.

📒 Files selected for processing (1)
  • source/_integrations/ntfy.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/ntfy.markdown

[uncategorized] ~114-~114: A determiner appears to be missing. Consider inserting it.
Context: ... | Set a delay for message delivery. Minimum delay is 10 seconds, maximum is 3 days....

(AI_EN_LECTOR_MISSING_DETERMINER)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (3)
source/_integrations/ntfy.markdown (3)

100-103: Section hierarchy and headings are well structured
The new “## Actions” and “### Publish notification” headings align with other Home Assistant integration docs, correctly nesting the feature under the Actions section.


104-105: Description clearly introduces ntfy.publish
The prose succinctly explains when and why to use the ntfy.publish action versus notify.send_message.


120-124: Emoji tip enhances discoverability
The {% tip %} block pointing to the emoji reference is well placed and formatted.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
source/_integrations/ntfy.markdown (3)

106-119: Nit: Tidy up table entries for consistency
A couple of small polish items in the data-attribute table will improve clarity and consistency:

  1. Delay description (line 114) is missing a determiner and could be two shorter sentences.
  2. Email description (line 116) is missing a terminal period.

Proposed diff:

- | `delay`        | yes      | Set a delay for message delivery. Minimum delay is 10 seconds, maximum is 3 days. |
+ | `delay`        | yes      | Set a delay for message delivery. The minimum delay is 10 seconds, and the maximum delay is 3 days. |

- | `email`        | yes      | Specify the address to forward the notification to, for example `[email protected]` |
+ | `email`        | yes      | Specify the address to forward the notification to, for example `[email protected]`. |
🧰 Tools
🪛 LanguageTool

[uncategorized] ~114-~114: A determiner appears to be missing. Consider inserting it.
Context: ... | Set a delay for message delivery. Minimum delay is 10 seconds, maximum is 3 days....

(AI_EN_LECTOR_MISSING_DETERMINER)


131-132: Fix YAML indentation for tags sequence
The sequence item under tags: must be indented further than the key to parse correctly.

Proposed diff:

-   tags:
-   - rotating_light
+   tags:
+     - rotating_light

144-144: Minor wording: consolidate "short codes" → "shortcodes"
For consistency with upstream ntfy docs (and most emoji guides), consider using “shortcodes” as a single word.

Proposed diff:

- Check out the [emoji reference](https://docs.ntfy.sh/emojis/) for a full list of supported emoji short codes.
+ Check out the [emoji reference](https://docs.ntfy.sh/emojis/) for a full list of supported emoji shortcodes.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5e59248 and be64b2f.

📒 Files selected for processing (1)
  • source/_integrations/ntfy.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/ntfy.markdown

[uncategorized] ~114-~114: A determiner appears to be missing. Consider inserting it.
Context: ... | Set a delay for message delivery. Minimum delay is 10 seconds, maximum is 3 days....

(AI_EN_LECTOR_MISSING_DETERMINER)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_integrations/ntfy.markdown (1)

100-105: Well-defined "Actions" section and introduction for ntfy.publish
The new heading and introductory text clearly explain the purpose of the ntfy.publish action and how it differs from notify.send_message. This aligns with existing integration documentation style.

@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft April 25, 2025 05:16
@tr4nt0r tr4nt0r marked this pull request as ready for review April 25, 2025 13:28
@home-assistant home-assistant bot requested a review from c0ffeeca7 April 25, 2025 13:28
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
source/_integrations/ntfy.markdown (2)

108-118: Clarify parameter value ranges and formats

To reduce ambiguity, consider specifying accepted formats and ranges:

  • priority: List valid values (for example, -2 to 5) or link to the ntfy API docs.
  • delay: Indicate the syntax (e.g., 10s, 5m, 1h, 3d).
  • tags: Show an inline example (tags: - smile).

Adding these details will help users configure parameters correctly on first try.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~108-~108: Loose punctuation mark.
Context: ...i, and more. #### Parameters - title: Title for your notification message. - ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~109-~109: Loose punctuation mark.
Context: ...r your notification message. - message: Your notification message. - markdown...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~110-~110: Loose punctuation mark.
Context: ... Your notification message. - markdown: Enable Markdown formatting for the mess...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~111-~111: Loose punctuation mark.
Context: ...rkdownguide.org/basic-syntax/). - tags: Add tags or emojis to the notification....

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~112-~112: Loose punctuation mark.
Context: ...w the notification content. - priority: All messages have a priority, which def...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...tification drawer or pop-over. - click: URL that is opened when the notificatio...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~114-~114: Loose punctuation mark.
Context: ...n the notification is clicked. - delay: Set a delay for message delivery. The m...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~115-~115: Loose punctuation mark.
Context: ... the maximum delay is 3 days. - attach: Attach images or other files by URL. - ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~116-~116: Loose punctuation mark.
Context: ... images or other files by URL. - email: Specify the address to forward the noti...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~116-~116: Possible missing comma found.
Context: ...ess to forward the notification to, for example [email protected]. - call: Phone num...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~117-~117: Loose punctuation mark.
Context: ...for example [email protected]. - call: Phone number to call and read the messa...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~118-~118: Loose punctuation mark.
Context: ...rior phone number verification. - icon: Include an icon that will appear next t...

(UNLIKELY_OPENING_PUNCTUATION)


120-139: Example YAML: use canonical data types

Home Assistant examples typically show numeric fields as bare integers, not quoted strings. You may want to update:

-  priority: "5"
+  priority: 5

Also, the tags list can be presented as:

tags:
  - rotating_light

to mirror common YAML style in integrations.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between be64b2f and 281a2e3.

📒 Files selected for processing (1)
  • source/_integrations/ntfy.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/ntfy.markdown

[uncategorized] ~108-~108: Loose punctuation mark.
Context: ...i, and more. #### Parameters - title: Title for your notification message. - ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~109-~109: Loose punctuation mark.
Context: ...r your notification message. - message: Your notification message. - markdown...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~110-~110: Loose punctuation mark.
Context: ... Your notification message. - markdown: Enable Markdown formatting for the mess...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~111-~111: Loose punctuation mark.
Context: ...rkdownguide.org/basic-syntax/). - tags: Add tags or emojis to the notification....

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~112-~112: Loose punctuation mark.
Context: ...w the notification content. - priority: All messages have a priority, which def...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...tification drawer or pop-over. - click: URL that is opened when the notificatio...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~114-~114: Loose punctuation mark.
Context: ...n the notification is clicked. - delay: Set a delay for message delivery. The m...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~115-~115: Loose punctuation mark.
Context: ... the maximum delay is 3 days. - attach: Attach images or other files by URL. - ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~116-~116: Loose punctuation mark.
Context: ... images or other files by URL. - email: Specify the address to forward the noti...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~116-~116: Possible missing comma found.
Context: ...ess to forward the notification to, for example [email protected]. - call: Phone num...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~117-~117: Loose punctuation mark.
Context: ...for example [email protected]. - call: Phone number to call and read the messa...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~118-~118: Loose punctuation mark.
Context: ...rior phone number verification. - icon: Include an icon that will appear next t...

(UNLIKELY_OPENING_PUNCTUATION)

🔇 Additional comments (4)
source/_integrations/ntfy.markdown (4)

100-103: Headings follow documentation conventions

The new “## Actions” section and its “### Publish notification” subsection align well with the existing structure (e.g., “## Notifiers”). Heading levels and spacing are consistent.


104-106: Introduction and parameters header are clear

The brief intro for ntfy.publish and the “#### Parameters” header clearly demarcate the options list. This makes it easy for users to find and understand the new action.


141-146: Defaults note is concise and helpful

The note clarifies that all parameters are optional and highlights the default behaviors for message and priority. This sets proper expectations without clutter.


147-151: Emoji tip enhances discoverability

Linking to the emoji reference is a great addition for users looking to spruce up notifications. It’s a useful pointer that adds value without overwhelming the docs.

c0ffeeca7
c0ffeeca7 previously approved these changes Apr 25, 2025
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @tr4nt0r 👍

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
source/_integrations/ntfy.markdown (2)

120-138: Nitpick: Unquoted numeric values
In the example YAML, priority is quoted ("5"), which may be parsed as a string. For clarity, use an unquoted integer:

   data:
-    priority: "5"
+    priority: 5

141-145: Nitpick: Add missing comma for readability
Insert a comma after “not specified” in the note block to improve flow:

-If `priority` is not specified the default priority (3) will be used.
+If `priority` is not specified, the default priority (3) will be used.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~143-~143: Possible missing comma found.
Context: ...text: triggered. If priority is not specified the default priority (3) will be used. ...

(AI_HYDRA_LEO_MISSING_COMMA)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 281a2e3 and 780e1e0.

📒 Files selected for processing (1)
  • source/_integrations/ntfy.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/ntfy.markdown

[uncategorized] ~108-~108: Loose punctuation mark.
Context: ... and emojis. #### Parameters - title: Title for your notification message. - ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~109-~109: Loose punctuation mark.
Context: ...r your notification message. - message: Your notification message. - markdown...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~110-~110: Loose punctuation mark.
Context: ... Your notification message. - markdown: Enable Markdown formatting for the mess...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~111-~111: Loose punctuation mark.
Context: ...rkdownguide.org/basic-syntax/). - tags: Add tags or emojis to the notification....

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~112-~112: Loose punctuation mark.
Context: ...w the notification content. - priority: All messages have a priority, which def...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...tification drawer or pop-over. - click: URL that is opened when the notificatio...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~114-~114: Loose punctuation mark.
Context: ...n the notification is clicked. - delay: Set a delay for message delivery. The m...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~115-~115: Loose punctuation mark.
Context: ... the maximum delay is 3 days. - attach: Attach images or other files by URL. - ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~116-~116: Loose punctuation mark.
Context: ... images or other files by URL. - email: Specify the address to forward the noti...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~116-~116: Possible missing comma found.
Context: ...ess to forward the notification to, for example [email protected]. - call: Phone num...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~117-~117: Loose punctuation mark.
Context: ...for example [email protected]. - call: Phone number to call and read the messa...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~118-~118: Loose punctuation mark.
Context: ...rior phone number verification. - icon: Include an icon that will appear next t...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~143-~143: Possible missing comma found.
Context: ...text: triggered. If priority is not specified the default priority (3) will be used. ...

(AI_HYDRA_LEO_MISSING_COMMA)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (4)
source/_integrations/ntfy.markdown (4)

100-102: Section headings follow documentation standards
The new ## Actions and ### Publish notification headings use sentence case and correctly nest under existing sections, aligning with Home Assistant guidelines.


104-105: Introduction to ntfy.publish is clear and concise
The paragraph differentiates the new action from notify.send_message and highlights key enhancements.


106-118: Parameters list is comprehensive and well-formatted
Each parameter is documented with clear descriptions and usage notes. Consider ordering the list alphabetically or grouping related options (e.g., links, attachments, forwarding) for enhanced readability if the list grows in the future.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~108-~108: Loose punctuation mark.
Context: ... and emojis. #### Parameters - title: Title for your notification message. - ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~109-~109: Loose punctuation mark.
Context: ...r your notification message. - message: Your notification message. - markdown...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~110-~110: Loose punctuation mark.
Context: ... Your notification message. - markdown: Enable Markdown formatting for the mess...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~111-~111: Loose punctuation mark.
Context: ...rkdownguide.org/basic-syntax/). - tags: Add tags or emojis to the notification....

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~112-~112: Loose punctuation mark.
Context: ...w the notification content. - priority: All messages have a priority, which def...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...tification drawer or pop-over. - click: URL that is opened when the notificatio...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~114-~114: Loose punctuation mark.
Context: ...n the notification is clicked. - delay: Set a delay for message delivery. The m...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~115-~115: Loose punctuation mark.
Context: ... the maximum delay is 3 days. - attach: Attach images or other files by URL. - ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~116-~116: Loose punctuation mark.
Context: ... images or other files by URL. - email: Specify the address to forward the noti...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~116-~116: Possible missing comma found.
Context: ...ess to forward the notification to, for example [email protected]. - call: Phone num...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~117-~117: Loose punctuation mark.
Context: ...for example [email protected]. - call: Phone number to call and read the messa...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~118-~118: Loose punctuation mark.
Context: ...rior phone number verification. - icon: Include an icon that will appear next t...

(UNLIKELY_OPENING_PUNCTUATION)


147-151: Emoji reference tip enhances user experience
The link to the emoji reference is valuable for users choosing emoji shortcodes.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

♻️ Duplicate comments (1)
source/_integrations/ntfy.markdown (1)

100-104: Implemented past suggestion: improved description for ntfy.publish action

This matches the previously proposed wording to highlight the advantages of ntfy.publish over notify.send_message, as suggested in earlier reviews.

🧹 Nitpick comments (1)
source/_integrations/ntfy.markdown (1)

120-138: Consider unquoting numeric values in the example

To align with typical YAML usage and avoid any confusion between strings and numbers, you may remove the quotes around the priority value:

-  priority: "5"
+  priority: 5

This clarifies that priority is an integer.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 780e1e0 and ed85db8.

📒 Files selected for processing (1)
  • source/_integrations/ntfy.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/ntfy.markdown

[uncategorized] ~108-~108: Loose punctuation mark.
Context: ... and emojis. #### Parameters - title: Title for your notification message. - ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~109-~109: Loose punctuation mark.
Context: ...r your notification message. - message: Your notification message. - markdown...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~110-~110: Loose punctuation mark.
Context: ... Your notification message. - markdown: Enable Markdown formatting for the mess...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~111-~111: Loose punctuation mark.
Context: ...rkdownguide.org/basic-syntax/). - tags: Add tags or emojis to the notification....

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~112-~112: Loose punctuation mark.
Context: ...w the notification content. - priority: All messages have a priority, which def...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...tification drawer or pop-over. - click: URL that is opened when the notificatio...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~114-~114: Loose punctuation mark.
Context: ...n the notification is clicked. - delay: Set a delay for message delivery. The m...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~115-~115: Loose punctuation mark.
Context: ... the maximum delay is 3 days. - attach: Attach images or other files by URL. - ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~116-~116: Loose punctuation mark.
Context: ... images or other files by URL. - email: Specify the address to forward the noti...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~117-~117: Loose punctuation mark.
Context: ...for example [email protected]. - call: Phone number to call and read the messa...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~118-~118: Loose punctuation mark.
Context: ...rior phone number verification. - icon: Include an icon that will appear next t...

(UNLIKELY_OPENING_PUNCTUATION)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (3)
source/_integrations/ntfy.markdown (3)

106-119: Parameter descriptions are clear and consistent

Each parameter is well-documented with defaults and usage context, maintaining consistency with Home Assistant documentation standards. Great coverage of optional fields and their behaviors.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~108-~108: Loose punctuation mark.
Context: ... and emojis. #### Parameters - title: Title for your notification message. - ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~109-~109: Loose punctuation mark.
Context: ...r your notification message. - message: Your notification message. - markdown...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~110-~110: Loose punctuation mark.
Context: ... Your notification message. - markdown: Enable Markdown formatting for the mess...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~111-~111: Loose punctuation mark.
Context: ...rkdownguide.org/basic-syntax/). - tags: Add tags or emojis to the notification....

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~112-~112: Loose punctuation mark.
Context: ...w the notification content. - priority: All messages have a priority, which def...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...tification drawer or pop-over. - click: URL that is opened when the notificatio...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~114-~114: Loose punctuation mark.
Context: ...n the notification is clicked. - delay: Set a delay for message delivery. The m...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~115-~115: Loose punctuation mark.
Context: ... the maximum delay is 3 days. - attach: Attach images or other files by URL. - ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~116-~116: Loose punctuation mark.
Context: ... images or other files by URL. - email: Specify the address to forward the noti...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~117-~117: Loose punctuation mark.
Context: ...for example [email protected]. - call: Phone number to call and read the messa...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~118-~118: Loose punctuation mark.
Context: ...rior phone number verification. - icon: Include an icon that will appear next t...

(UNLIKELY_OPENING_PUNCTUATION)


141-145: Note on optional parameters is helpful

The note clearly describes default behaviors for omitted parameters, improving user guidance and reducing guesswork.


147-151: Emoji reference tip is spot on

Linking to the emoji shortcode documentation provides users an easy way to explore supported emojis and enrich their notifications.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants