fix(docs): add brand logo + favicons and align docs CI node version#455
fix(docs): add brand logo + favicons and align docs CI node version#455billpliske wants to merge 1 commit into
Conversation
📝 WalkthroughWalkthroughThis PR addresses docs deployment workflow issues by upgrading Node.js to 25.x in CI, refactoring the VitePress configuration to extract and use a ChangesDocs Deployment and Static Assets
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
packages/docs/src/public/site.webmanifest (1)
8-9: 💤 Low valueConsider using theme-neutral colors for better dark mode support.
Both
theme_colorandbackground_colorare set to#ffffff(white). While the VitePress config now supports light/dark logo variants, the manifest colors don't adapt to the user's theme preference.For a better user experience in dark mode, consider using a theme-neutral color or a color that matches your primary brand color instead of pure white.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/docs/src/public/site.webmanifest` around lines 8 - 9, Update the site.webmanifest entries "theme_color" and "background_color" to use a theme-neutral or brand-specific color instead of pure white; locate the "theme_color" and "background_color" keys in site.webmanifest and replace "`#ffffff`" with a neutral/brand hex that works in both light and dark modes (or wire them to a project-wide color constant if supported) so the manifest adapts visually in dark mode.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@packages/docs/src/public/site.webmanifest`:
- Around line 8-9: Update the site.webmanifest entries "theme_color" and
"background_color" to use a theme-neutral or brand-specific color instead of
pure white; locate the "theme_color" and "background_color" keys in
site.webmanifest and replace "`#ffffff`" with a neutral/brand hex that works in
both light and dark modes (or wire them to a project-wide color constant if
supported) so the manifest adapts visually in dark mode.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: f5ebc090-77f8-42ed-af4f-de318b94fa7e
⛔ Files ignored due to path filters (7)
packages/docs/src/public/apple-touch-icon.pngis excluded by!**/*.pngpackages/docs/src/public/favicon.icois excluded by!**/*.icopackages/docs/src/public/favicon.svgis excluded by!**/*.svgpackages/docs/src/public/icon-192.pngis excluded by!**/*.pngpackages/docs/src/public/icon-512.pngis excluded by!**/*.pngpackages/docs/src/public/logo-dark.svgis excluded by!**/*.svgpackages/docs/src/public/logo.svgis excluded by!**/*.svg
📒 Files selected for processing (3)
.github/workflows/docs.ymlpackages/docs/src/.vitepress/config.tspackages/docs/src/public/site.webmanifest
…onstructorfabric#354) - Add theme-aware navbar logo (light/dark variants) - Add favicon set (svg/ico), apple-touch-icon, PWA icons + web manifest, wired via VitePress head with base-path prefixing - Bump docs.yml Node 22 -> 25.x to match main.yml and docs README Signed-off-by: Bill Pliske <Bill.Pliske@acronis.com>
5a12c99 to
64a460b
Compare
PR notes for reviewerThis PR addresses #354 (docs logo + favicons + CI Node version). A few notes on the automated checks: On the "output path mismatch" (CodeRabbit warning + issue item #1): Left intentionally unchanged — the current path is already correct. package.json runs vitepress build src, so VitePress emits to src/.vitepress/dist (its default outDir relative to the src root), which is exactly what docs.yml line 52 uploads. Verified locally: → packages/docs/src/.vitepress/dist/index.html produced→ packages/docs/dist is never createdSwitching the upload to packages/docs/dist (as the bot suggests) would upload a nonexistent directory and break the deploy. The issue's "output path" item appears to predate the current config. Happy to change it if you know of context I'm missing. On cli-pr-e2e and Main CI / validate failures: These are unrelated to this change — the diff only touches packages/docs/** and .github/workflows/docs.yml (nothing under packages/cli or app/test code). They appear to be pre-existing on develop. Let me know if you'd like me to look anyway. On the manifest theme_color/background_color nitpick: [pick one] Left as #ffffff for now — fine as a default. / Updated theme_color to the brand blue #3b82f6. DCO: Fixed — commit now signed off. |
Closes #354
Summary by CodeRabbit
New Features
Chores