-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
base: current
Are you sure you want to change the base?
Conversation
WalkthroughThis 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
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
Suggested reviewers
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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
📒 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
.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.