fix: prevent linked doc headings from disappearing behind page header

[AlCalzone]

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).
  • I've opened up a PR to add logos and icons in Brands repository.
• Added documentation for a new feature I'm adding to Home Assistant (next branch).
• Removed stale or deprecated documentation.

Additional information

• This PR fixes or closes issue: fixes Multiline headings disappear behind the page header when clicking the TOC #35108

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

  • Improved styling for headings to prevent overlap with the site header.
  • Enhanced visual presentation and responsiveness of various UI elements, including cards and menus.

• Bug Fixes

  • Adjusted positioning for targeted elements to ensure proper visibility.

• Style

  • Refined layout and spacing for better alignment across different screen sizes.

[netlify]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	dfc4ea4
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/6703a3141806290008dfad00
😎 Deploy Preview	https://deploy-preview-35114--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle 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]

📝 Walkthrough

Walkthrough

The changes in the pull request involve modifications to the SCSS file sass/homeassistant/_overrides.scss, focusing on styling adjustments for headings, layout elements, and media queries. Key updates include setting headings to position: relative;, altering the :target pseudo-class properties, and refining various classes for improved appearance and responsiveness. Additionally, general layout adjustments have been made to enhance alignment and spacing across different components, contributing to a more cohesive visual hierarchy and user interaction.

Changes

File

Change Summary

sass/homeassistant/_overrides.scss

- Added position: relative; to headings (h1-h6) to prevent overlap with the site header. - Modified :target pseudo-class to position: absolute;, top: -100px;, and visibility: hidden;. - Retained media queries with layout adjustments for .grid-wrapper and other elements. - Refined styles for .material-card, .menu, and .footer focusing on padding, margins, and hover effects. - Adjusted layout for .feedback, .hero, and .frontpage for better alignment and spacing.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Browser
    participant SiteHeader
    participant Content

    User->>Browser: Clicks heading link
    Browser->>SiteHeader: Check heading position
    SiteHeader-->>Browser: Position is relative
    Browser->>Content: Scroll to target element
    Content-->>Browser: Display target element

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 936713e and dfc4ea4.

📒 Files selected for processing (1)

• sass/homeassistant/_overrides.scss (1 hunks)

🧰 Additional context used

🔇 Additional comments (3)

sass/homeassistant/_overrides.scss (3)

1362-1365: LGTM! This change prevents headings from disappearing behind the site header.

The addition of position: relative to all heading elements (h1 to h6) is a good solution. It creates a new stacking context for these elements, which helps prevent them from being hidden behind the fixed site header when linked to.

---

1366-1370: Excellent solution for handling linked headings!

This change to the :target pseudo-class is well thought out:

1. position: absolute and top: -100px move the target element up, creating space for the fixed header.
2. visibility: hidden ensures this doesn't cause any visual disruption.

This approach, combined with the position: relative on headings, effectively solves the issue of linked headings being hidden behind the fixed header.

---

Line range hint 1372-1375: Great addition for a fixed header!

This new CSS rule for .site-header complements the previous changes:

1. position: fixed keeps the header at the top of the viewport.
2. width: 100% ensures it spans the full width of the page.
3. z-index: 999 guarantees that the header stays on top of other elements.

This change, combined with the adjustments to headings and :target, creates a robust solution for maintaining visible linked headings with a fixed header.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[frenck]

Thanks, @AlCalzone 👍

../Frenck