-
-
Notifications
You must be signed in to change notification settings - Fork 199
Update main docs logo #800
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
Conversation
WalkthroughUpdated MkDocs configuration by changing the theme logo path in mkdocs.yml from images/logo.svg to images/armbian-logo.png. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
✨ Finishing Touches🧪 Generate unit tests
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:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type 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 (3)
mkdocs.yml (3)
30-30: Consider aligning the favicon with the new brand asset.
favicon: images/logo.pngstill references the old file. If there’s a corresponding new favicon (e.g.,images/armbian-logo.pngor a dedicatedfavicon.ico/favicon.svg), update it for consistency across tabs and PWA manifests.If you have an SVG favicon:
- favicon: images/logo.png + favicon: images/armbian-logo.svgOtherwise, ensure a 48–64px PNG (plus optional 180px Apple touch icon) is produced and referenced where appropriate.
17-29: Optional: provide a dark-mode variant if the logo isn’t high-contrast on “slate”.If the new logo loses contrast on the dark palette, you can swap the logo per palette using a tiny CSS override.
Add to
css/armbian-extra.css:/* Use a different logo in dark mode if needed */ [data-md-color-scheme="slate"] .md-header__button.md-logo img { content: url("../images/armbian-logo-dark.svg"); /* provide dark-optimized asset */ }I can supply a PR-ready variant of the CSS and asset references if you share the dark-optimized logo filename.
14-14: Logo asset verified
- ✅ Found
docs/images/armbian-logo.pngat the expected location.- 🔍 No
armbian-logo.svgalternative detected in the repository.The update to
logo: images/armbian-logo.pngis good to merge.• Optional: if a vector version becomes available, switch to
- logo: images/armbian-logo.png + logo: images/armbian-logo.svgfor crisper scaling and smaller payload.
• Please confirm the current PNG has a transparent background and remains legible in both light and dark themes.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (1)
docs/images/armbian-logo.pngis excluded by!**/*.png
📒 Files selected for processing (1)
mkdocs.yml(1 hunks)
Documentation website preview will be available shortly:
Open WWW preview