Skip to content

Fix headings on latest blog cards #38701

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 5 commits into from
Apr 23, 2025
Merged

Fix headings on latest blog cards #38701

merged 5 commits into from
Apr 23, 2025

Conversation

mrdarrengriffin
Copy link
Contributor

@mrdarrengriffin mrdarrengriffin commented Apr 23, 2025 •
edited
Loading

Proposed change

The PR that separated the blog posts had a Copilot fix for heading structure which in-turn broke the style of the heading in those cards

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.

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

netlify bot commented Apr 23, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 6181c35
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/680957048fa9400008208156
😎 Deploy Preview https://deploy-preview-38701--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.

@mrdarrengriffin mrdarrengriffin marked this pull request as ready for review April 23, 2025 21:10
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 23, 2025

📝 Walkthrough

Walkthrough

The changes update the heading levels in the news.html template file. Specifically, the "Release Notes" and "Recent Blog Posts" section headings are changed from level 2 headings (<h2>) to level 1 headings (<h1>). No other parts of the template, such as loops, conditionals, or content structure, are modified.

Changes

File Change Summary
source/_includes/custom/news.html Changed "Release Notes" and "Recent Blog Posts" headings from <h2> to <h1>.

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to HTML heading levels and do not affect control flow or feature logic.

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.

coderabbitai[bot]
coderabbitai bot reviewed Apr 23, 2025
View reviewed changes
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 (2)
source/_includes/custom/news.html (2)

8-8: Verify intended use of <h1> for “Release Notes” section
Changing this from <h2> to <h1> introduces an additional top-level heading. For accessibility and SEO best practices, pages typically have a single <h1> (the page title), with subsections using <h2> or deeper. Please confirm that multiple <h1> tags are acceptable in your design system, or consider reverting to <h2>/<h3> to maintain a proper hierarchy.

35-35: Verify intended use of <h1> for “Recent Blog Posts” section
Similarly, this section now uses <h1>, further increasing top-level headings on the page. If the goal is consistent subsection styling, a lower-level heading (e.g. <h2>) may be more appropriate. Please ensure the overall heading structure remains semantically correct.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5625d31 and 6181c35.

📒 Files selected for processing (1)
  • source/_includes/custom/news.html (2 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

@mrdarrengriffin mrdarrengriffin enabled auto-merge (squash) April 23, 2025 21:12
@mrdarrengriffin
Copy link
Contributor Author

Using h1's for these cards is not correct hence my fix to move these to h2's. However, it appears that h1's and h2's are styled differently for the material cards. Something I will put a better fix in for tomorrow

@mrdarrengriffin mrdarrengriffin merged commit 3e32264 into current Apr 23, 2025
9 checks passed
@mrdarrengriffin mrdarrengriffin deleted the release-notes-separation branch April 23, 2025 21:36
@github-actions github-actions bot locked and limited conversation to collaborators Apr 24, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@balloob balloob balloob 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
@mrdarrengriffin @balloob