Add description for new favorite button in Music Assistant #39703
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the newly introduced favorite current song button in the Music Assistant integration. The changes include updating the integration platforms list and adding a detailed description of how the button works, including its behavior when no playable content is available.
Comments suppressed due to low confidence (1)
source/_integrations/music_assistant.markdown:54
- [nitpick] To align with the Oxford comma usage in the style guidelines, add a comma after 'AirPlay'.
The Music Assistant integration creates a button entity per player to favorite the current song. Pressing this button entity manually or by an automation, will attempt to add the currently playing song to your Music Assistant favorites. This will work for local playing songs, tracks from streaming providers and if/when remote content such as Spotify Connect, AirPlay or even a radio station is playing, as long as the external source provides an artist and title combination (and optionally the album). Note that the button will be marked as unavailable if there is no content playable that could be favorited.
📝 WalkthroughWalkthroughThe documentation for the Music Assistant integration in Home Assistant was updated to describe new support for the Button platform. It now details a button entity per player that allows users to favorite the currently playing song, applicable to various content types when metadata is available. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant MusicAssistant
participant Player
User->>HomeAssistant: Press "Favorite current song" button
HomeAssistant->>Player: Get currently playing song metadata
HomeAssistant->>MusicAssistant: Request to add current song to favorites
MusicAssistant-->>HomeAssistant: Confirmation/Status update
HomeAssistant-->>User: Button entity state updated
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 2
🔭 Outside diff range comments (1)
source/_integrations/music_assistant.markdown (1)
12-15:ha_platformsfront-matter now out of sync with the actual functionalityThe front-matter still declares only the
media_playerplatform, so the new button entity won’t show up in autogenerated lists or the integration overview.
Addbuttonto keep the metadata authoritative.ha_platforms: - media_player + - button
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/music_assistant.markdown(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.
source/_integrations/*: Integration documentation must use the provided template structure and section order.
source/_integrations/music_assistant.markdown
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/music_assistant.markdown
23-23: Link fragments should be valid
null
(MD051, link-fragments)
56-56: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
⏰ 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
| ### Favorite current song button | ||
|
|
||
| The Music Assistant integration creates a button entity per player to favorite the current song. Pressing this button entity manually or by an automation, will attempt to add the currently playing song to your Music Assistant favorites. This will work for local playing songs, tracks from streaming providers and if/when remote content such as Spotify Connect, AirPlay or even a radio station is playing, as long as the external source provides an artist and title combination (and optionally the album). Note that the button will be marked as unavailable if there is no content playable that could be favorited. | ||
|
|
||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Heading naming & spacing violate template and break anchor; extra blank line
- Template expects a plain
### Buttonsection, not a customised title. - Using the standard heading automatically yields the
#buttonanchor, fixing the link above. - Two consecutive blank lines (MD012) slip in after the paragraph.
-### Favorite current song button
+### Button
@@
-Note that the button will be marked as unavailable if there is no content playable that could be favorited.
-
+Note that the button will be marked as unavailable if there is no content playable that could be favorited.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Favorite current song button | |
| The Music Assistant integration creates a button entity per player to favorite the current song. Pressing this button entity manually or by an automation, will attempt to add the currently playing song to your Music Assistant favorites. This will work for local playing songs, tracks from streaming providers and if/when remote content such as Spotify Connect, AirPlay or even a radio station is playing, as long as the external source provides an artist and title combination (and optionally the album). Note that the button will be marked as unavailable if there is no content playable that could be favorited. | |
| ### Button | |
| The Music Assistant integration creates a button entity per player to favorite the current song. Pressing this button entity manually or by an automation, will attempt to add the currently playing song to your Music Assistant favorites. This will work for local playing songs, tracks from streaming providers and if/when remote content such as Spotify Connect, AirPlay or even a radio station is playing, as long as the external source provides an artist and title combination (and optionally the album). Note that the button will be marked as unavailable if there is no content playable that could be favorited. |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
56-56: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
🤖 Prompt for AI Agents
In source/_integrations/music_assistant.markdown around lines 52 to 56, the
heading "### Favorite current song button" should be renamed to the standard
"### Button" to comply with the template and fix the broken anchor link. Also,
remove the extra blank line after the paragraph to avoid consecutive blank lines
and adhere to markdown style guidelines.
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/music_assistant.markdown (1)
51-55: Heading violates template + extra blank lineDocs for integration platforms must use the canonical
### Buttonheading; diverging breaks uniform anchors and lint checks. The consecutive blank line after the paragraph also triggers MD012.-### Favorite current song button +### Button @@ -Note that the button will be marked as unavailable if there is no content playable that could be favorited. - +Note that the button will be marked as unavailable if no favoritable content is currently playing.
🧹 Nitpick comments (1)
source/_integrations/music_assistant.markdown (1)
22-24: Anchor & wording drift from integration template
- The template expects the Button entry to link to
#button; adjusting the anchor keeps navigation consistent across all docs.- Minor wording tweak removes filler “of”.
- - [Button](#favorite-current-song-button) - All of the Home Assistant [Media Player Control Actions](https://www.home-assistant.io/integrations/media_player/#media-control-actions) are supported. + - [Button](#button) + All Home Assistant [Media Player Control Actions](https://www.home-assistant.io/integrations/media_player/#media-control-actions) are supported.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/music_assistant.markdown(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.
source/_integrations/*: Integration documentation must use the provided template structure and section order.
source/_integrations/music_assistant.markdown
🪛 LanguageTool
source/_integrations/music_assistant.markdown
[style] ~23-~23: Consider removing “of” to be more concise
Context: ...Button All of the Home Assistant [Media Player Control Ac...
(ALL_OF_THE)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/music_assistant.markdown
55-55: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
source/_integrations/music_assistant.markdown (1)
51-55: Use standard heading & remove extra blank line to satisfy template + MD012.
- Rename the heading to exactly
### Button; the template insists on the plain platform name.- Dropping the bespoke title automatically resolves the anchor warned above.
- One blank line is sufficient between sections – the second triggers MD012.
-### Favorite current song button - -The Music Assistant integration creates a button entity for each player to favorite the current song. Pressing this button (manually or by automation) adds the current song to your Music Assistant favorites. This works for local playing songs and tracks from streaming providers. It also works with remote content such as Spotify Connect, AirPlay, or a radio station, as long as the external source provides an artist and title combination (and optionally the album). Note that the button will be marked as unavailable if there is no content playable that could be favorited. - - +### Button + +The Music Assistant integration creates a button entity for each player to favorite the current song. Pressing this button (manually or by automation) adds the current song to your Music Assistant favorites. This works for local playing songs and tracks from streaming providers. It also works with remote content such as Spotify Connect, AirPlay, or a radio station, as long as the external source provides an artist and title combination (and optionally the album). Note that the button will be marked as unavailable if there is no content playable that could be favorited.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/music_assistant.markdown(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.
source/_integrations/*: Integration documentation must use the provided template structure and section order.
source/_integrations/music_assistant.markdown
🪛 LanguageTool
source/_integrations/music_assistant.markdown
[style] ~23-~23: Consider removing “of” to be more concise
Context: ...Button All of the Home Assistant [Media Player Control Ac...
(ALL_OF_THE)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/music_assistant.markdown
55-55: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
⏰ 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
| - [Media player](#media-player) | ||
|
|
||
| - [Button](#favorite-current-song-button) | ||
| All of the Home Assistant [Media Player Control Actions](https://www.home-assistant.io/integrations/media_player/#media-control-actions) are supported. |
There was a problem hiding this comment.
Anchor mismatch with template – update link slug to #button.
The template’s platform index expects the canonical “### Button” section which generates the #button slug.
Keeping a custom slug silently breaks other docs that rely on the standard structure and trips MD051.
- - [Button](#favorite-current-song-button)
+ - [Button](#button)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [Media player](#media-player) | |
| - [Button](#favorite-current-song-button) | |
| All of the Home Assistant [Media Player Control Actions](https://www.home-assistant.io/integrations/media_player/#media-control-actions) are supported. | |
| - [Media player](#media-player) | |
| - [Button](#button) | |
| All of the Home Assistant [Media Player Control Actions](https://www.home-assistant.io/integrations/media_player/#media-control-actions) are supported. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: A punctuation mark might be missing here.
Context: ...me Assistant Platforms: - Media player - Button A...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[style] ~23-~23: Consider removing “of” to be more concise
Context: ...Button All of the Home Assistant [Media Player Control Ac...
(ALL_OF_THE)
🪛 markdownlint-cli2 (0.17.2)
22-22: Link fragments should be valid
null
(MD051, link-fragments)
🤖 Prompt for AI Agents
In source/_integrations/music_assistant.markdown around lines 22 to 24, the link
slug for the Button section is incorrectly set to #favorite-current-song-button
instead of the canonical #button. Update the link slug to #button to match the
template’s expected anchor, ensuring consistency and preventing broken links or
markdown linting errors.
Add a description for the new button entity that was added to the Music Assistant integration to add the currently playing song to your favorites.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit