Document pre-announcement

[balloob]

Proposed change

Docs for home-assistant/architecture#1213

Type of change

• Document existing features within Home Assistant
• Document new or changing features which there is an existing pull request elsewhere
• Spelling or grammatical corrections, or rewording for improved clarity
• Changes to the backend of this documentation
• Removed stale or deprecated documentation

Additional information

• This PR fixes or closes issue: fixes #
• Link to relevant existing code or pull request:

Summary by CodeRabbit

• Documentation
  • Updated documentation to clarify how an optional preannouncement media is handled. The changes explain that when this parameter is provided, the system plays the preannouncement before the main media, ensuring the correct sequence of operations.

[coderabbitai]

📝 Walkthrough

Walkthrough

The documentation for the async_announce and async_start_conversation methods in the AssistSatelliteEntity has been updated. The changes now describe the inclusion of a new parameter, preannouncement_media_id. If provided, this parameter triggers a preannouncement step where the associated media is played before the main media_id is announced. The documentation adjustments explain the modified control flow within these methods.

Changes

File Path	Change Summary
docs/.../assist-satellite.md	Updated documentation for async_announce and async_start_conversation to include handling of the new preannouncement_media_id parameter, describing the new preannouncement sequence before the main announcement.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant A as AssistSatelliteEntity
    participant Announcer as async_announce

    U->>A: async_start_conversation(media_id, preannouncement_media_id?)
    alt If preannouncement_media_id is provided
        A->>Announcer: async_announce(preannouncement_media_id)
        Announcer-->>A: Preannouncement completed
    end
    A->>Announcer: async_announce(media_id)
    Announcer-->>A: Announcement completed
    A-->>U: Conversation started

Loading

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 289f668 and 1c1f1fc.

📒 Files selected for processing (1)

• docs/core/entity/assist-satellite.md (2 hunks)

🔇 Additional comments (2)

docs/core/entity/assist-satellite.md (2)

66-67: Clarify the preannouncement behavior in announcements

The updated section clearly explains that when a preannouncement_media_id is provided, it should be played before the main media_id. This addition properly informs developers about the expected behavior for the async_announce method.

---

75-77: Enhance the step-by-step flow for starting a conversation

The newly added numbered list succinctly outlines the process for the async_start_conversation method, indicating that the preannouncement (if provided) is played first, followed by the main announcement and then transitioning to the listening phase. This sequence establishes clear expectations for implementers.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[MartinHjelmare]

It would help to add the signature of the entity methods that the platform can implement. We have that for most other entity integrations.

I assume we also need to update the user docs for the service actions.

[MartinHjelmare]

User docs have been merged.