Skip to content

Terminology: standardize spelling of three dots menu #39825

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 2 commits into from
Jul 3, 2025

Conversation

c0ffeeca7
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 commented Jul 3, 2025

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

  • Documentation
    • Updated various documentation pages to clarify references to the "three-dot menu" by explicitly including the vertical dots icon next to the text. This enhances visual clarity and consistency across instructions for interacting with menu options in the user interface. No procedural or functional instructions were changed.

@Copilot Copilot AI review requested due to automatic review settings July 3, 2025 08:49
@home-assistant home-assistant bot added the current This PR goes into the current branch label Jul 3, 2025
Copy link

netlify bot commented Jul 3, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 029724e
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/686645b1159a09000813b7a9
😎 Deploy Preview https://deploy-preview-39825--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.

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 standardizes the phrasing of the overflow menu for “three dots” across multiple documentation pages by replacing “three-dot menu” with “three dots {% icon 'mdi:dots-vertical' %} menu”.

  • Unified terminology and icon usage for consistency
  • Updated dozens of Markdown pages accordingly

Reviewed Changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated no comments.

Show a summary per file
File Description
source/voice_control/aliases.markdown Updated “three-dot menu” to “three dots {% icon 'mdi:dots-vertical' %} menu”
source/getting-started/onboarding_dashboard.markdown Updated phrasing for the delete card step
source/_integrations/zwave_js.markdown Standardized phrasing in logging and removal steps
source/_integrations/zha.markdown Standardized phrasing for the options menu
source/_integrations/xiaomi_ble.markdown Standardized phrasing in firmware steps
source/_integrations/telegram_bot.markdown Standardized phrasing in allowlist chat ID step
source/_integrations/reolink.markdown Standardized phrasing in device removal steps
source/_integrations/onkyo.markdown Standardized phrasing for reconfigure step
source/_integrations/ntfy.markdown Standardized phrasing in adding a topic step
source/_integrations/monzo.markdown Standardized phrasing in adding credentials step
source/_integrations/matter.markdown Standardized phrasing in remove device steps
source/_integrations/homee.markdown Standardized phrasing for reconfigure step
source/_integrations/heos.markdown Standardized phrasing for reconfigure and delete steps
source/_integrations/dlna_dms.markdown Standardized phrasing in renaming step
source/_integrations/application_credentials.markdown Standardized phrasing in delete credential step
source/_includes/integrations/remove_device_service_steps.md Standardized phrasing in remove step
source/_includes/common-tasks/beta_version.md Standardized phrasing in join beta step
source/_docs/tools/dev-tools.markdown Standardized phrasing for quick reload step
source/_docs/organizing/categories.markdown Standardized phrasing for category edit/delete step
source/_docs/organizing/areas.markdown Standardized phrasing for delete area step
source/_docs/configuration/troubleshooting.markdown Standardized phrasing for download diagnostics step
source/_docs/automation/using_blueprints.markdown Standardized phrasing for re-import blueprint step
Comments suppressed due to low confidence (1)

source/voice_control/aliases.markdown:33

  • Fix typo: replace multliple with multiple.
## Adding an alias of a floor

klaasnicolaas
klaasnicolaas previously approved these changes Jul 3, 2025
Copy link
Contributor

coderabbitai bot commented Jul 3, 2025

Warning

Rate limit exceeded

@c0ffeeca7 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 13 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 57bc7b7 and 029724e.

📒 Files selected for processing (1)
  • source/voice_control/aliases.markdown (1 hunks)
📝 Walkthrough

Walkthrough

This update standardizes the documentation across multiple files by replacing textual references to the "three-dot menu" with a more explicit description, often including the actual vertical dots icon markup ({% icon "mdi:dots-vertical" %}). The changes clarify UI instructions without altering any procedural steps, logic, or control flow.

Changes

Files/Paths Change Summary
source/_docs/automation/using_blueprints.markdown
source/_docs/configuration/troubleshooting.markdown
source/_docs/organizing/areas.markdown
source/_docs/organizing/categories.markdown
source/_docs/tools/dev-tools.markdown
source/_includes/common-tasks/beta_version.md
source/_integrations/application_credentials.markdown
source/_integrations/dlna_dms.markdown
source/_integrations/onkyo.markdown
source/_integrations/monzo.markdown
source/_integrations/matter.markdown
source/_integrations/zha.markdown
source/_integrations/zwave_js.markdown
source/_integrations/ntfy.markdown
source/_integrations/homee.markdown
source/_integrations/telegram_bot.markdown
source/_integrations/reolink.markdown
source/_integrations/xiaomi_ble.markdown
source/_includes/integrations/remove_device_service_steps.md
source/getting-started/onboarding_dashboard.markdown
source/voice_control/aliases.markdown
Updated documentation to replace "three-dot menu" (and variants) with "three dots" and/or explicit icon markup {% icon "mdi:dots-vertical" %} for clarity in UI instructions. No functional or procedural changes.

Sequence Diagram(s)

No sequence diagram is generated, as the changes are purely textual and do not affect control flow or introduce new features.


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: 0

🧹 Nitpick comments (5)
source/_integrations/xiaomi_ble.markdown (1)

61-62: Add the {% icon %} tag to match documentation guidelines

The style-guide asks us to reference UI icons via the Iconify tag.
Everywhere else in this PR we already do so, but this bullet still lacks it.

- - The installed and latest firmware version can be verified by selecting the plant -> three dots menu -> Hardware settings -> Hardware update
+ - The installed and latest firmware version can be verified by selecting the plant → three dots {% icon "mdi:dots-vertical" %} menu → **Hardware settings** → **Hardware update**
source/_integrations/zha.markdown (1)

560-562: Use the {% icon %} tag & terminate the sentence properly

For consistency with the rest of the docs (and with other changes in this PR) the vertical-dots icon should be referenced via {% icon "mdi:dots-vertical" %}.
Also, end the list item with a period instead of a trailing comma.

-2. In the options menu (the "three dots" icon), select **Manage Zigbee device**,
+2. In the options menu (the three dots {% icon "mdi:dots-vertical" %} icon), select **Manage Zigbee device**.
source/voice_control/aliases.markdown (2)

36-36: Minor wording tweak for smoother reading
“the three dots … menu” reads a little clunky; dropping the trailing noun keeps it short and still unambiguous.

-2. Next to the floor of interest, select the three dots {% icon "mdi:dots-vertical" %} menu, then select **Edit floor**.
+2. Next to the floor of interest, select the three dots {% icon "mdi:dots-vertical" %}, then choose **Edit floor**.

40-41: Remove extra blank line (MD012)

Static-analysis flagged two consecutive blank lines before the heading.

-
-
### Area-less aliases for entities with an assigned area
+### Area-less aliases for entities with an assigned area
source/_integrations/monzo.markdown (1)

44-46: Grammar & preposition clean-up

LanguageTool rightfully notes the missing article and the preferred preposition “on”. Also, breaking the long sentence after the first period aids readability.

-   - In the top right of **Devices & services** page, select the three dots {% icon "mdi:dots-vertical" %} menu, open **Application Credentials**, and select **Add application credentials**
+   - On the top right of the **Devices & services** page, select the three dots {% icon "mdi:dots-vertical" %} menu.  
+     Open **Application credentials**, then select **Add application credentials**
📜 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 f1b9733 and 57bc7b7.

📒 Files selected for processing (22)
  • source/_docs/automation/using_blueprints.markdown (1 hunks)
  • source/_docs/configuration/troubleshooting.markdown (1 hunks)
  • source/_docs/organizing/areas.markdown (1 hunks)
  • source/_docs/organizing/categories.markdown (1 hunks)
  • source/_docs/tools/dev-tools.markdown (1 hunks)
  • source/_includes/common-tasks/beta_version.md (1 hunks)
  • source/_includes/integrations/remove_device_service_steps.md (1 hunks)
  • source/_integrations/application_credentials.markdown (1 hunks)
  • source/_integrations/dlna_dms.markdown (1 hunks)
  • source/_integrations/heos.markdown (2 hunks)
  • source/_integrations/homee.markdown (1 hunks)
  • source/_integrations/matter.markdown (1 hunks)
  • source/_integrations/monzo.markdown (1 hunks)
  • source/_integrations/ntfy.markdown (1 hunks)
  • source/_integrations/onkyo.markdown (1 hunks)
  • source/_integrations/reolink.markdown (2 hunks)
  • source/_integrations/telegram_bot.markdown (1 hunks)
  • source/_integrations/xiaomi_ble.markdown (1 hunks)
  • source/_integrations/zha.markdown (1 hunks)
  • source/_integrations/zwave_js.markdown (2 hunks)
  • source/getting-started/onboarding_dashboard.markdown (1 hunks)
  • source/voice_control/aliases.markdown (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.md`: Lists should be surrounded by blank lines. Use numbered lists for seq...

**/*.md: Lists should be surrounded by blank lines.
Use numbered lists for sequential steps, procedures, or prioritized items; use bullet lists for non-sequential items.
Begin each item in a list with a capital letter, unless it is a command or code block.
Do not use semicolons, commas, or conjunctions at the end of list items.
Do not use a period at the end of list items unless they are complete sentences.
Write content in a flowing text style in Markdown files; if not, adjust to flowing text.
Do not use tables in documentation; use lists instead, as tables do not render well on mobile devices.
Use the commonmark specification for Markdown.
Use Markdown for writing content; avoid HTML where possible.
When using code fenced code blocks, specify the language for syntax highlighting.
Contents of a code fenced code block must never exceed 80 character line length.
Use ATX style heading syntax (use '#' for headings) in Markdown files.
Ensure header increments are correct and do not skip any levels; the page title in front matter is the first level heading, so all content below should be at least a second level heading.
Use '-' for unordered lists and '.' for ordered lists in Markdown.
Use '_' for italic text and '**' for bold text in Markdown.
Use backticks when referring to file paths, file names, variable names, or text entered in a field.
Use Liquid syntax for templating in Jekyll within Markdown files.
To indicate a location in the UI, use the 'My link' Liquid tag.
To reference glossary terms, use the '{% term %}' Liquid tag.
Avoid using abbreviations and acronyms; if used, add an abbreviation tag to show the full term as a tooltip.
To refer to an icon in the UI, use the Iconify library via the '{% icon %}' Liquid tag.
Use the '{% details %}' Liquid block for collapsible text blocks; do not use the HTML5 variant.
Use '{% tip %}', '{% note %}', and '{% important %}' Liquid blocks for highlighting recommendations and important sections.
Use Markdown syntax to add images; use HTML only for images with captions.
Use the specified HTML syntax for embedding YouTube videos.
For YAML examples, use 2 spaces for indentation.
Only allow 'true' and 'false' (lowercase) as boolean values in YAML examples.
YAML comments must match the current indentation level, start with a capital letter, and have a space after the hash.
Prefer block style sequences in YAML; avoid flow style sequences.
If flow style sequences are used in YAML, ensure a space after each comma and no whitespace before brackets.
Only allow block style mappings in YAML; do not use flow style mappings.
Null values in YAML should be implicitly marked; avoid explicit null values ('~' and 'null').
Strings in YAML are preferably quoted with double quotes (").
For multi-line strings in YAML, use literal (|) or folded (>) style; avoid '\n' or long single-line strings.
Do not include configuration options with default values in YAML examples unless specifically educating about that option.
Entity IDs, attributes, device IDs, area IDs, platform types, condition types, trigger types, action names, device classes, event names, and hardcoded values are exempt from double-quoting in YAML.
Use service action targets in YAML examples for Home Assistant service calls; do not specify entity_id at the action or data level.
Do not use comma-separated strings or flow style for lists of scalar values in YAML; use block style lists.
If a property accepts a mapping or a list of mappings in YAML, always use a list of mappings, even for a single item.
Avoid using templates in YAML examples if a pure YAML version is available.
Templates in YAML must be double-quoted, with single quotes used inside the template.
Avoid long lines in YAML templates; split across multiple lines for readability.
Prefer shorthand style templates in YAML over the expressive format.
Require spacing around the filter pipe marker ' | ' in YAML templates.
Do not use the states object directly in YAML templates; use helper methods like states(), is_state(), state_attr(), is_state_attr().
Remove empty conditions, default 'mode: single', and empty 'data' sections from automation and script YAML examples.
Textual contents in YAML parameters (like 'title') should follow the same writing style as the documentation, including sentence-style capitalization.

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

  • source/_includes/integrations/remove_device_service_steps.md
  • source/_includes/common-tasks/beta_version.md
🪛 LanguageTool
source/_docs/organizing/areas.markdown

[uncategorized] ~96-~96: Consider adding a hyphen.
Context: ... %} and select the area card. 2. In the top right corner, select the three dots {% icon "...

(TOP_LEFT_CORNER)

source/_integrations/monzo.markdown

[uncategorized] ~45-~45: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...fore* trying to add the new entry. - In the top right of Devices & services...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)


[uncategorized] ~45-~45: You might be missing the article “the” here.
Context: ...the new entry. - In the top right of Devices & services page, select the t...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🪛 markdownlint-cli2 (0.17.2)
source/voice_control/aliases.markdown

40-40: 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
🔇 Additional comments (21)
source/_includes/integrations/remove_device_service_steps.md (1)

1-4: LGTM – wording & icon markup are compliant
No further action required.

source/_integrations/homee.markdown (1)

101-104: LGTM – change follows style-guide and already contains the icon tag
No issues spotted.

source/_integrations/ntfy.markdown (1)

45-49: LGTM – wording, icon usage and list formatting are correct
Nothing to change.

source/_integrations/heos.markdown (2)

72-74: LGTM – Consistent “three dots” wording with icon

The updated phrasing and inclusion of {% icon "mdi:dots-vertical" %} matches the new terminology standard. No further action needed.


82-83: LGTM – Removal section follows the new convention

The second occurrence is likewise corrected and stays consistent with the reconfiguration step.

source/_docs/organizing/areas.markdown (1)

96-97: LGTM – Menu reference standardized

The change cleanly adopts the new “three dots” pattern with icon markup and reads well.

source/_integrations/application_credentials.markdown (1)

52-53: LGTM – Terminology update applied

The instructions now consistently reference the three-dots menu with the icon; looks good.

source/_docs/organizing/categories.markdown (1)

55-56: LGTM – Consistent menu wording

Standardized wording and icon inclusion are correct here as well.

source/_docs/tools/dev-tools.markdown (1)

31-31: LGTM – Developer-tools path clarified

Icon markup added; sentence remains clear and aligns with the new style guide.

source/getting-started/onboarding_dashboard.markdown (1)

125-125: ✅ Terminology update is clear and correctly formatted

The updated wording and added icon markup match the style used throughout the docs. Nothing else to address here.

source/_integrations/telegram_bot.markdown (1)

110-110: Consistent “three dots” phrasing—looks good

The phrase now aligns with the standardized terminology and includes the correct icon macro. No further changes required.

source/_integrations/reolink.markdown (1)

532-533: Terminology update is consistent and clear

The new wording and icon inclusion follow the emerging style-guide pattern and read well. No further action needed.

Also applies to: 541-542

source/_docs/configuration/troubleshooting.markdown (1)

130-131: Good alignment with UI language

Replacing the plain text with the iconified “three dots” reference matches other docs and removes ambiguity. Looks solid.

source/_integrations/dlna_dms.markdown (1)

22-23: Consistent wording

Change mirrors the standardized phrasing adopted elsewhere; reads naturally in context.

source/_integrations/onkyo.markdown (1)

35-36: Update fits the style guide

The icon inclusion clarifies the instruction without altering meaning. No concerns.

source/_docs/automation/using_blueprints.markdown (1)

78-79: Clearer step-by-step instruction

Iconified “three dots” reference brings this in line with other docs. Looks good.

source/_includes/common-tasks/beta_version.md (2)

13-13: Change looks good – spelling now matches the new terminology.
No further issues spotted for this bullet item.


18-18: Consistent update, no problems.
Icon usage & wording comply with the style guide.

source/_integrations/zwave_js.markdown (1)

1085-1085: Terminology update applied correctly
All new references follow the agreed “three dots {% icon … %}” pattern—nice work.

source/_integrations/matter.markdown (2)

316-317: Terminology change looks good

The wording now follows the new “three dots {% icon "mdi:dots-vertical" %} menu” terminology and matches the project-wide standardization objective.


320-321: Consistent update applied here as well

This instance also correctly adopts the standardized phrasing with the icon inclusion. No further issues spotted.

@c0ffeeca7
Copy link
Contributor Author

thanks for the review!

@frenck frenck merged commit 6a921a8 into current Jul 3, 2025
9 checks passed
@frenck frenck deleted the terminology-stadardize-three-dots-menu branch July 3, 2025 09:19
@github-actions github-actions bot locked and limited conversation to collaborators Jul 4, 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.

3 participants