Skip to content

Update voice language picker #39775

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

Merged
merged 11 commits into from
Jul 4, 2025
Merged

Update voice language picker #39775

merged 11 commits into from
Jul 4, 2025

Conversation

mrdarrengriffin
Copy link
Contributor

@mrdarrengriffin mrdarrengriffin commented Jun 30, 2025

Proposed change

Updates the voice language picker to use the new data sources

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

    • Language support details are now dynamically loaded, providing more accurate and descriptive information for each language.
    • Language selection dropdown features improved labels with country/region annotations and a clearer default prompt.
    • Added an automated task to download and update language support data.
  • Enhancements

    • The local and cloud processing sections have been visually restructured for greater clarity, with updated graphics and explanatory content.
    • FAQ content has been revised to clarify local and cloud speech-to-text options and hardware recommendations.
    • Language support cards now display detailed descriptive text based on dynamic data.
  • Style

    • Improved layout and styling for navigation, local/cloud sections, language support cards, and responsive design across the page.
  • Chores

    • Updated file handling to exclude specific data files from version control.
    • Removed obsolete interactive toggling of local/cloud display for a cleaner user experience.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Jun 30, 2025
Copy link

netlify bot commented Jun 30, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 0156d6f
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/6867da2fcfcf550008f831a1
😎 Deploy Preview https://deploy-preview-39775--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 project configuration.

@mrdarrengriffin mrdarrengriffin marked this pull request as ready for review July 4, 2025 12:17
@Copilot Copilot AI review requested due to automatic review settings July 4, 2025 12:17
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR refactors the voice language picker to source support data from a centralized JSON, updates the local/cloud comparison graphics and styling, and adds a Rake task to fetch language support scores automatically.

  • CSS enhancements for responsive layout and new graphic-card link styling
  • JavaScript refactor to drive language support UI from window.language_scores
  • Markup updates to the language selector options and local/cloud feature comparison
  • New Rake task to download language_scores.json data

Reviewed Changes

Copilot reviewed 4 out of 8 changed files in this pull request and generated 3 comments.

File Description
source/voice-pe/styles.css Expanded and refactored CSS for local/cloud cards and lines
source/voice-pe/script.js Removed hard-coded support table, bound select placeholder, and used window.language_scores
source/voice-pe/index.html Overhauled HTML for language picker and local/cloud graphic sections; injected language_scores
Rakefile Added task to fetch remote language_scores.json
Comments suppressed due to low confidence (2)

source/voice-pe/styles.css:2155

  • Missing semicolon at the end of this declaration, which will produce a CSS syntax error. Add ; after the value.
  height: calc(var(--grid-m) * 16)

source/voice-pe/index.html:681

  • Duplicate <option> entry for pt-BR. Remove the redundant option to prevent confusing the select choices.
              <option value="pt-BR">Portuguese (Brazil)</option>

Copy link
Contributor

coderabbitai bot commented Jul 4, 2025

📝 Walkthrough

Walkthrough

The updates introduce a new Rake task to fetch language score data, update the .gitignore to exclude this data file, and significantly revise the Voice Preview Edition web page. The HTML, CSS, and JavaScript are restructured for clarity, dynamic language support, and improved local/cloud processing explanations, with corresponding layout and style changes.

Changes

File(s) Change Summary
.gitignore Added source/_data/language_scores.json to ignored files.
Rakefile Added new language_scores_data Rake task to download and save language score JSON data from ohf-voice.github.io.
source/voice-pe/index.html Revised local/cloud processing layout and content; updated language dropdown and FAQ; added inline script exposing window.language_scores.
source/voice-pe/script.js Removed registerCycleLocalCloud and related toggling logic; refactored updateLanguageSupports to use window.language_scores object with new data format; added placeholder option in registerNiceSelect.
source/voice-pe/styles.css Extensive layout and style refinements for local/cloud and language support sections; updated responsive design, card states, and animations; removed redundant CSS.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Rake Task
    participant Server (ohf-voice.github.io)
    participant Browser

    User->>Rake Task: Run language_scores_data task
    Rake Task->>Server (ohf-voice.github.io): GET /intents/language_scores.json
    Server (ohf-voice.github.io)-->>Rake Task: Return language_scores.json
    Rake Task->>File System: Save as source/_data/language_scores.json

    User->>Browser: Load Voice Preview Edition page
    Browser->>Browser: Inline script exposes window.language_scores
    Browser->>Browser: updateLanguageSupports() uses window.language_scores to update UI
Loading

📜 Recent 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

📥 Commits

Reviewing files that changed from the base of the PR and between 447c0b4 and 0156d6f.

📒 Files selected for processing (1)
  • source/voice-pe/script.js (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
  • GitHub Check: Lint Text
🔇 Additional comments (5)
source/voice-pe/script.js (5)

31-31: Good UX improvement with the placeholder addition.

Adding a placeholder to the language selector improves the user experience by providing clear guidance.


449-460: Well-structured language descriptions object.

The languageDescriptions object provides clear, user-friendly descriptions for different support levels. The hierarchical structure makes it easy to maintain and extend.


462-468: Improved error handling and data source.

The refactoring to use window.language_scores with proper error handling is a good improvement over hardcoded data.


469-475: DOM element queries with proper null checks.

Good practice to verify elements exist before attempting to use them.


491-503: Local support logic correctly implements the state mapping.

The conditional logic properly maps the focused_local and full_local values to the appropriate states (0-3) as defined in the languageDescriptions object.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need 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)

  • @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: 4

🔭 Outside diff range comments (1)
source/voice-pe/script.js (1)

462-508: Add error handling for missing language scores data.

The refactored function logic is sound, but it should handle cases where window.language_scores is undefined or empty.

Add defensive programming:

 function updateLanguageSupports(locale = null) {
+    if (!window.language_scores) {
+        console.warn('Language scores data not available');
+        return;
+    }
     let data = window.language_scores;
🧹 Nitpick comments (2)
source/voice-pe/styles.css (2)

2188-2203: Hard-coded negative margins risk horizontal scroll

The new .devices block uses margin-left: -120px; which can create unwanted horizontal overflow on narrow viewports or when --grid-m changes.
Consider using flex/grid alignment rather than magic numbers.


2390-2399: line-dashed animation: colour hard-coded black

background is black, whereas the rest of the design derives colours from custom props.
Exposing it as var(--color) or a dedicated variable would keep themes consistent.

📜 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

📥 Commits

Reviewing files that changed from the base of the PR and between c000b40 and 0260e14.

⛔ Files ignored due to path filters (3)
  • source/images/voice-pe/local-cloud/ha-instance.svg is excluded by !**/*.svg
  • source/images/voice-pe/local-cloud/house.svg is excluded by !**/*.svg
  • source/voice-pe/rounded-path.svg is excluded by !**/*.svg
📒 Files selected for processing (5)
  • .gitignore (1 hunks)
  • Rakefile (1 hunks)
  • source/voice-pe/index.html (10 hunks)
  • source/voice-pe/script.js (3 hunks)
  • source/voice-pe/styles.css (23 hunks)
⏰ 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 (7)
.gitignore (1)

11-11: LGTM! Correctly excluding generated data file.

This addition follows the established pattern of ignoring generated JSON data files and aligns with the new Rake task that downloads language scores data.

source/voice-pe/script.js (2)

31-31: LGTM! Placeholder update is consistent.

The placeholder change aligns with the HTML updates and improves user experience.


449-460: Well-structured language descriptions.

The languageDescriptions object provides clear, informative descriptions for different support states and makes the code more maintainable.

source/voice-pe/index.html (3)

30-31: LGTM! Documentation links updated correctly.

The documentation URL updates point to the correct support categories.

Also applies to: 44-45


467-468: Good content improvement.

The revised text is more concise and clear.


634-698: Improved language selection with descriptive names.

The updated language options with country/region annotations provide better user experience and clarity.

source/voice-pe/styles.css (1)

479-485: z-index raise to 6 – verify stacking context

Bumping .vpe-nav to z-index: 6 may place it above the modal (.video-modal uses z-index: 10) but could still eclipse other overlays added later.
Please confirm there are no pop-ups/tooltips in the range 7-9, or pick a constant from a shared scale.

mrdarrengriffin and others added 4 commits July 4, 2025 13:24
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@mrdarrengriffin mrdarrengriffin marked this pull request as draft July 4, 2025 13:33
@mrdarrengriffin mrdarrengriffin marked this pull request as ready for review July 4, 2025 13:35
@frenck frenck merged commit 18f7cdf into current Jul 4, 2025
9 checks passed
@frenck frenck deleted the voice-language-ui-update branch July 4, 2025 13:50
thecode pushed a commit that referenced this pull request Jul 4, 2025
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@github-actions github-actions bot locked and limited conversation to collaborators Jul 5, 2025
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.

2 participants