Skip to content

Default dashboards: order descriptions alphabetically #38713

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 24, 2025
Merged

Default dashboards: order descriptions alphabetically #38713

merged 1 commit into from
Apr 24, 2025

Conversation

c0ffeeca7
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 commented Apr 24, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Default dashboards: order descriptions alphabetically

  • no content changes, just reordering the topics to make it easier to find.

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
    • Reorganized and renamed dashboard sections for improved clarity and consistency.
    • Updated the list of default dashboards to use consistent naming and order.
    • Moved and updated descriptions for the History and Map dashboards for better structure.
    • No changes to functionality or instructions.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Apr 24, 2025
@netlify Netlify
Copy link

netlify bot commented Apr 24, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit e8b2e43
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/680a41c7582c210008db0346
😎 Deploy Preview https://deploy-preview-38713--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.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 24, 2025

📝 Walkthrough

Walkthrough

The documentation for dashboards was reorganized to improve clarity and consistency. Section titles were updated to consistently include the "dashboard" suffix. The order of the default dashboards was changed, and the sections for the History and Map dashboards were swapped. The History dashboard section received a more concise description, while the Map dashboard content and its subsections were relocated without textual changes. No changes were made to the underlying functionality or technical instructions.

Changes

File(s) Change Summary
source/dashboards/dashboards.markdown Reordered and renamed dashboard sections for consistency; updated dashboard list with "dashboard" suffix; reorganized History and Map dashboard sections; revised History dashboard description for conciseness; relocated Map dashboard content and subsections.

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to documentation structure and text reorganization.

📜 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 9949d42 and e8b2e43.

📒 Files selected for processing (1)
  • source/dashboards/dashboards.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/dashboards/dashboards.markdown

[style] ~37-~37: Consider removing “of” to be more concise
Context: ...dashboard](#to-do-lists-dashboard) Not all of the predefined dashboards are listed under ...

(ALL_OF_THE)

[uncategorized] ~53-~53: A comma might be missing here.
Context: ...tions/#presence-detection). This is the case for example if you have the [Home Assis...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

[uncategorized] ~53-~53: A comma might be missing here.
Context: ...esence-detection). This is the case for example if you have the [Home Assistant Compani...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

⏰ 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 (3)
source/dashboards/dashboards.markdown (3)

30-35: Alphabetical ordering and naming consistency applied
The default dashboards list is now sorted alphabetically and each item uniformly uses the “dashboard” suffix. All intra-page anchors (e.g., #history-dashboard, #map-dashboard) and external links remain correct.

39-42: History dashboard section relocated and updated
The “### History dashboard” header and its concise description have been correctly moved to follow the alphabetical list. The anchor (#history-dashboard) matches the header, and the link to the History integration documentation is still accurate.

47-53: Map dashboard section reordered with its subsection
The “### Map dashboard” header, its overview paragraph, and the “#### Maps and presence detection” subsection have been relocated to their new alphabetical position. All anchors and cross-references continue to align after the move.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~53-~53: A comma might be missing here.
Context: ...tions/#presence-detection). This is the case for example if you have the [Home Assis...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

[uncategorized] ~53-~53: A comma might be missing here.
Context: ...esence-detection). This is the case for example if you have the [Home Assistant Compani...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

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.
    • 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 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.

@joostlek joostlek merged commit 717e8b4 into current Apr 24, 2025
9 checks passed
@joostlek joostlek deleted the default-dashboards-reorder branch April 24, 2025 14:02
@github-actions github-actions bot locked and limited conversation to collaborators Apr 25, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@joostlek joostlek joostlek approved these changes

Assignees
No one assigned
Labels
current This PR goes into the current branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@c0ffeeca7 @joostlek