Skip to content

Link back to / from the sidebar logo #4789

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

Open
wants to merge 1 commit into
base: current
Choose a base branch
from

Conversation

akx
Copy link

@akx akx commented Apr 2, 2025

Description:

This PR makes the sidebar's ESPHome logo link back to /, because I could find no other way to get back to the site root from e.g. a guide.

Checklist:

  • I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

  • Link added in /components/index.rst when creating new documents for new components or cookbook.

Copy link
Contributor

coderabbitai bot commented Apr 2, 2025

Walkthrough

This pull request makes modifications to the logo presentation in the sidebar. A new CSS rule is added to remove borders and text decoration from the logo link. Additionally, an external SVG file is introduced for the logo, and the searchbox template is updated to reference this external SVG via an anchor tag instead of embedding the SVG inline.

Changes

File(s) Change Summary
_static/custom.css Added a new CSS rule for div.sphinxsidebar .logo-link that removes borders and text decoration.
_templates/_logo_svg.html, _templates/searchbox.html Introduced an external SVG logo file and updated the searchbox template to reference this file via an anchor tag, replacing the previously embedded inline SVG.

Sequence Diagram(s)

sequenceDiagram
    participant B as Browser
    participant T as Template Engine
    B->>T: Request search page
    T->>T: Render searchbox.html
    T->>T: Include logo via _logo_svg.html (via anchor link)
    T-->>B: Return rendered page with external logo
Loading

Suggested reviewers

  • jesserockz
  • kbx81

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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 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 (2)
_static/custom.css (1)

377-380: Ensure the new logo-link styling meets design consistency.
The new CSS rule for the .logo-link within the sidebar is clear and minimalistic, effectively removing borders and text decorations from the clickable logo. This correctly supports the intent of having a cleaner, non-intrusive link back to the homepage.

Optional: Consider adding a hover state for improved user feedback if that fits your design guidelines.

_templates/_logo_svg.html (1)

1-25: New SVG logo file review.
The SVG file is well-formed and leverages CSS variables (--logo-casita-color and --logo-text-color) for flexible theming. The use of an external file for the logo enhances maintainability, and the <defs> section cleanly encapsulates styling directives.

Suggestion: One of the <path> elements in the casita group uses a hard-coded fill (fill="#FFFFFF"). For a fully themeable logo, you might consider replacing it with a CSS variable (or adjusting via CSS later) so that the white element can also respond to theme changes if needed.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 59eaa4f and 79d2237.

📒 Files selected for processing (3)
  • _static/custom.css (1 hunks)
  • _templates/_logo_svg.html (1 hunks)
  • _templates/searchbox.html (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams

**: - Do not generate or add any sequence diagrams

  • _templates/_logo_svg.html
  • _templates/searchbox.html
  • _static/custom.css
🔇 Additional comments (1)
_templates/searchbox.html (1)

1-1: Clickable logo update in the searchbox template.
Replacing the inline SVG with an anchor tag (<a href="/" class="logo-link">{% include "_logo_svg.html" %}</a>) is a concise and effective approach to make the logo clickable. This change directly addresses the PR objective of improving navigation and is properly integrated with the new CSS rule from _static/custom.css.

Copy link

netlify bot commented Apr 2, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 79d2237
🔍 Latest deploy log https://app.netlify.com/sites/esphome/deploys/67ecdb35b99c7f00086b7597
😎 Deploy Preview https://deploy-preview-4789--esphome.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.

@akx akx mentioned this pull request Apr 9, 2025
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant