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

VPE launch blog #36443

Merged
merged 4 commits into from
Dec 19, 2024
Merged

VPE launch blog #36443

merged 4 commits into from
Dec 19, 2024

Conversation

googanhiem
Copy link
Contributor

@googanhiem googanhiem commented Dec 19, 2024

Proposed change

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

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

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

  • New Features

    • Introduced two new blog posts: "Voice Chapter 8 - Assist in the home today" and "The era of open voice assistants has arrived."
    • Detailed functionalities and advancements of the Assist voice assistant and Home Assistant Voice Preview Edition.
    • Highlighted community involvement and open-source nature of the Voice Preview Edition.
  • Documentation

    • Added comprehensive overviews, including command processing, device management, and privacy features.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Dec 19, 2024
Copy link

netlify bot commented Dec 19, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 13b63d8
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67647b29bc95a4000856b917
😎 Deploy Preview https://deploy-preview-36443--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 Dec 19, 2024

Caution

Review failed

The pull request is closed.

📝 Walkthrough
📝 Walkthrough

Walkthrough

Two new blog posts have been added to the Home Assistant blog, focusing on voice assistant technology. The first post, "Voice Chapter 8 - Assist in the home today" by Mike Hansen, explores the capabilities of the Assist voice assistant. The second post, "The era of open voice assistants has arrived" by Paulus Schoutsen, introduces the Home Assistant Voice Preview Edition, highlighting its open-source, privacy-focused approach to voice technology.

Changes

File Changes
source/_posts/2024-12-19-voice-chapter-8-assist-in-the-home.markdown - Added new blog post about Assist voice assistant
- Configured post metadata including layout, title, description, date, author, comments, categories, and Open Graph image
source/_posts/2024-12-19-voice-preview-edition-the-era-of-open-voice.markdown - Added new blog post about Voice Preview Edition
- Configured post metadata including title, description, author, categories, and Open Graph image

Sequence Diagram

sequenceDiagram
    participant User
    participant VoiceAssistant as Home Assistant Assist
    participant HomeAssistant as Home Assistant Core
    
    User->>VoiceAssistant: Speak voice command
    VoiceAssistant->>VoiceAssistant: Process wake word
    VoiceAssistant->>VoiceAssistant: Convert speech to text
    VoiceAssistant->>HomeAssistant: Send processed command
    HomeAssistant->>HomeAssistant: Execute command
    HomeAssistant->>VoiceAssistant: Return confirmation
    VoiceAssistant->>User: Provide voice response
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 46ffd64 and 13b63d8.

📒 Files selected for processing (2)
  • source/_posts/2024-12-19-voice-chapter-8-assist-in-the-home.markdown (1 hunks)
  • source/_posts/2024-12-19-voice-preview-edition-the-era-of-open-voice.markdown (1 hunks)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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. (Beta)
  • @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 (5)
source/_posts/2024-12-19-voice-preview-edition-the-era-of-open-voice.markdown (3)

49-49: Add a comma for better readability

Add a comma after "Voice Preview Edition" to improve sentence flow.

-When you get your hands on Voice Preview Edition the first thing you'll notice
+When you get your hands on Voice Preview Edition, the first thing you'll notice
🧰 Tools
🪛 LanguageTool

[uncategorized] ~49-~49: Possible missing comma found.
Context: ...hen you get your hands on Voice Preview Edition the first thing you'll notice is its pr...

(AI_HYDRA_LEO_MISSING_COMMA)


89-89: Hyphenate compound modifier

Add a hyphen to "auto-gain control" as it's a compound modifier.

-auto gain control
+auto-gain control
🧰 Tools
🪛 LanguageTool

[uncategorized] ~89-~89: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...ellation, stationary noise removal, and auto gain control, which all adds up to clearer a...

(AUTO_HYPHEN)


121-121: Consider stronger wording

Replace "really" with a more impactful word to strengthen the statement.

-this is a really big leap
+this is a significant leap
🧰 Tools
🪛 LanguageTool

[style] ~121-~121: As an alternative to the over-used intensifier ‘really’, consider replacing this phrase.
Context: ...and feeling piece of hardware - this is a really big leap for voice hardware. I expect it to...

(EN_WEAK_ADJECTIVE)

source/_posts/2024-12-19-voice-chapter-8-assist-in-the-home.markdown (2)

49-49: Consider more formal language

Replace the informal phrase "pretty much" with more professional wording.

-allow you to control pretty much every aspect
+allow you to control virtually every aspect
🧰 Tools
🪛 LanguageTool

[style] ~49-~49: The phrase ‘pretty much’ can be informal. To strengthen your writing, consider removing it or replacing it with an adverb.
Context: ...ll them intents, allow you to control pretty much every aspect of your smart home, includ...

(PRETTY_MUCH)


[style] ~49-~49: Consider using a different verb to strengthen your wording.
Context: ...se, and more. We also have intents that give you helpful information like what's the...

(GIVE_INFORMATION)


110-110: Remove redundant wording

The phrase "new innovations" is redundant as innovations are inherently new.

-So many new innovations and improvements
+So many innovations and improvements
🧰 Tools
🪛 LanguageTool

[style] ~110-~110: ‘new innovations’ might be wordy. Consider a shorter alternative.
Context: ...ave the choice. ## Conclusion So many new innovations and improvements for Assist have happen...

(EN_WORDINESS_PREMIUM_NEW_INNOVATIONS)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8d6adb0 and 46ffd64.

⛔ Files ignored due to path filters (16)
  • source/images/blog/2024-12-voice-chapter-8/art.png is excluded by !**/*.png
  • source/images/blog/2024-12-voice-chapter-8/assist.png is excluded by !**/*.png
  • source/images/blog/2024-12-voice-chapter-8/buy-now.png is excluded by !**/*.png
  • source/images/blog/2024-12-voice-chapter-8/language-support.png is excluded by !**/*.png
  • source/images/blog/2024-12-voice-chapter-8/timer.webm is excluded by !**/*.webm
  • source/images/blog/2024-12-voice-chapter-8/voice-pipeline.png is excluded by !**/*.png
  • source/images/blog/2024-12-voice-chapter-8/vpe-packaging.png is excluded by !**/*.png
  • source/images/blog/2024-12-vpe/3d-prints.jpg is excluded by !**/*.jpg
  • source/images/blog/2024-12-vpe/art.jpg is excluded by !**/*.jpg
  • source/images/blog/2024-12-vpe/buy-now.png is excluded by !**/*.png
  • source/images/blog/2024-12-vpe/grove.jpg is excluded by !**/*.jpg
  • source/images/blog/2024-12-vpe/local-cloud.png is excluded by !**/*.png
  • source/images/blog/2024-12-vpe/voice-preview-edition.png is excluded by !**/*.png
  • source/images/blog/2024-12-vpe/vpe-finish.png is excluded by !**/*.png
  • source/images/blog/2024-12-vpe/vpe-packaging.png is excluded by !**/*.png
  • source/images/blog/2024-12-vpe/vpe-price.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • source/_posts/2024-12-19-voice-chapter-8-assist-in-the-home.markdown (1 hunks)
  • source/_posts/2024-12-19-voice-preview-edition-the-era-of-open-voice.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_posts/2024-12-19-voice-preview-edition-the-era-of-open-voice.markdown

[uncategorized] ~49-~49: Possible missing comma found.
Context: ...hen you get your hands on Voice Preview Edition the first thing you'll notice is its pr...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~55-~55: To elevate your writing, try using a synonym here.
Context: ...of Voice Preview Edition"> It's hard to convey how nice the rotary dial is t...

(HARD_TO)


[misspelling] ~55-~55: Did you mean “in front of” or “the front of”?
Context: ...roval%20Factor,-We%20have%20a) was very front of mind when designing it. We also worked...

(FRONT_OF)


[style] ~73-~73: Consider using a shorter alternative to avoid wordiness.
Context: ...people as possible to join us early and make it better. ### Built for Home Assistant Many ot...

(MADE_IT_JJR)


[uncategorized] ~89-~89: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...ellation, stationary noise removal, and auto gain control, which all adds up to clearer a...

(AUTO_HYPHEN)


[style] ~117-~117: Consider using a different verb for a more formal wording.
Context: ...SPHome is that you are never alone when fixing an issue or adding a feature. We made t...

(FIX_RESOLVE)


[uncategorized] ~117-~117: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...or adding a feature. We made this device so the community could start working more ...

(COMMA_COMPOUND_SENTENCE_2)


[style] ~121-~121: As an alternative to the over-used intensifier ‘really’, consider replacing this phrase.
Context: ...and feeling piece of hardware - this is a really big leap for voice hardware. I expect it to...

(EN_WEAK_ADJECTIVE)

source/_posts/2024-12-19-voice-chapter-8-assist-in-the-home.markdown

[duplication] ~17-~17: Possible typo: you repeated a word
Context: ...duction run of Voice Preview Edition (a preview preview 😉), and we tried to get them in the ha...

(ENGLISH_WORD_REPEAT_RULE)


[style] ~49-~49: The phrase ‘pretty much’ can be informal. To strengthen your writing, consider removing it or replacing it with an adverb.
Context: ...ll them intents, allow you to control pretty much every aspect of your smart home, includ...

(PRETTY_MUCH)


[style] ~49-~49: Consider using a different verb to strengthen your wording.
Context: ...se, and more. We also have intents that give you helpful information like what's the...

(GIVE_INFORMATION)


[style] ~96-~96: Consider a different adverb to strengthen your wording.
Context: ...t](/voice-pe/#language-support). We're always looking for new solutions for low-power...

(ALWAYS_CONSTANTLY)


[style] ~96-~96: Consider using an alternative to strengthen your wording.
Context: ...her the needed translations, but if you want to learn more visit [Rhasspy Speech](ht...

(WANT_KEEN)


[style] ~110-~110: ‘new innovations’ might be wordy. Consider a shorter alternative.
Context: ...ave the choice. ## Conclusion So many new innovations and improvements for Assist have happen...

(EN_WORDINESS_PREMIUM_NEW_INNOVATIONS)


[typographical] ~112-~112: If the phrase ‘what about’ starts a question, add a question mark (“?”) at the end of the sentence. If ‘what about’ is not a question, then in some cases ‘about’ is not necessary and in some cases, use ‘about what’.
Context: ...ce, what about improving (this or that)". The good news is that improving Assist ...

(WHAT_ABOUT_QUESTION_MARK)

🔇 Additional comments (2)
source/_posts/2024-12-19-voice-preview-edition-the-era-of-open-voice.markdown (1)

1-28: LGTM! Well-structured front matter and introduction.

The metadata is complete and the introduction effectively uses lite-youtube for performance optimization.

source/_posts/2024-12-19-voice-chapter-8-assist-in-the-home.markdown (1)

1-38: LGTM! Well-structured front matter and engaging introduction.

The metadata is complete and the introduction effectively references the companion post. The playful word repetition with emoji adds personality to the text.

🧰 Tools
🪛 LanguageTool

[duplication] ~17-~17: Possible typo: you repeated a word
Context: ...duction run of Voice Preview Edition (a preview preview 😉), and we tried to get them in the ha...

(ENGLISH_WORD_REPEAT_RULE)

Copy link
Contributor Author

@googanhiem googanhiem left a comment

Choose a reason for hiding this comment

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

Looks good to go

@frenck frenck merged commit 207d165 into home-assistant:current Dec 19, 2024
6 of 7 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Dec 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants