chore(deps): upgrade to mkdocs-material@9.7.6#908
Open
achrinza wants to merge 8 commits into
Open
Conversation
Contributor
WalkthroughThis pull request upgrades the Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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.
Inline comments:
In `@mkdocs.yml`:
- Around line 379-382: The Material config block under extra is using a
misspelled key, so analytics is not being picked up. Update the key in
mkdocs.yml from the typo to the correct extra.analytics name, keeping the
existing provider and property values unchanged. Use the surrounding extra block
to locate the fix.
In `@theme/partials/nav-item.html`:
- Around line 203-209: The leaf-node branch in nav-item.html opens a <li> in the
else path but never closes it before the endif block, leaving the list markup
unbalanced. Update the nav-item template’s leaf branch so the <li> opened around
the nav_item.url link is properly closed after the <a> in the same branch,
matching the section branch’s structure and preserving the existing
render_content(nav_item) behavior.
In `@theme/partials/tabs.html`:
- Around line 8-9: Remove the leftover hardcoded tab links in tabs.html that
duplicate the migrated navigation entries and bypass site URL handling. Update
the tabs rendering to rely on the existing nav.items-driven navigation used by
the template rather than fixed "Stemcells" and "Releases" anchors, so links
respect config.site_url and use_directory_urls. If those pages are still needed,
move them into the navigation configuration instead of keeping them hardcoded in
the tabs partial.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 496b17ce-2743-4b52-a035-8c28b8a1de97
⛔ Files ignored due to path filters (1)
content/images/logo-full-white.pngis excluded by!**/*.png
📒 Files selected for processing (10)
README.mdci/tasks/build.ymlcontent/index.mdmkdocs.ymltheme/partials/copyright.htmltheme/partials/footer.htmltheme/partials/nav-item.htmltheme/partials/nav.htmltheme/partials/source.htmltheme/partials/tabs.html
- Migrated config - Migrated theme overrides Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
achrinza
force-pushed
the
chore/upgrade-mkdocs
branch
from
ad38b48 to
a896a9b
Compare
cf-foundation-community-automation
Bot
moved this to Inbox
in Foundational Infrastructure Working Group
github-project-automation
Bot
moved this from Inbox
to Pending Merge | Prioritized
in Foundational Infrastructure Working Group
Use newer Material for MkDocs features to reduce reliance on custom theme overrides. Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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.
Inline comments:
In `@mkdocs.yml`:
- Around line 356-380: The Markdown config is enabling pymdownx.highlight
without the Material-recommended options needed for full code-block highlighting
support. Update the markdown_extensions entry for pymdownx.highlight in
mkdocs.yml to include anchor_linenums, line_spans, and pygments_lang_class, and
keep it alongside pymdownx.inlinehilite, pymdownx.snippets, and
pymdownx.superfences so the code-copy and line-anchor behavior works as
intended.
In `@theme/partials/nav-item.html`:
- Around line 196-201: The pseudo-section branch in nav-item.html renders an
interactive label without a matching input, so update the is_section == True
path to use non-interactive heading markup instead of a label. In the nav item
template, keep the existing rendering logic around render_content(nav_item) and
md-nav__icon, but remove the for/id/tabindex label behavior for this
pseudo-section case so it cannot emit an empty tabindex or act as a toggle.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 69b08055-a0fa-44e4-b8f4-381722066a5f
⛔ Files ignored due to path filters (1)
content/images/logo-full-white.pngis excluded by!**/*.png
📒 Files selected for processing (10)
README.mdci/tasks/build.ymlcontent/index.mdmkdocs.ymltheme/assets/stylesheets/extra.61026d2ee9f4.csstheme/partials/footer.htmltheme/partials/nav-item.htmltheme/partials/nav.htmltheme/partials/source.htmltheme/partials/tabs.html
💤 Files with no reviewable changes (4)
- theme/partials/nav.html
- theme/partials/footer.html
- theme/partials/source.html
- theme/partials/tabs.html
github-project-automation
Bot
moved this from Pending Merge | Prioritized
to Waiting for Changes | Open for Contribution
in Foundational Infrastructure Working Group
Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
Code highlight used by the docs does not depend on this module Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
github-project-automation
Bot
moved this from Waiting for Changes | Open for Contribution
to Pending Merge | Prioritized
in Foundational Infrastructure Working Group
Member
|
Hi @achrinza, Thank you for opening this. Looks good from my perspective. The only change I would make is the logo colors. This is outside the scope of this PR but it appears the new version is more strict and found some issue that we should separately address as well. For example. |
Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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.
Inline comments:
In `@theme/assets/stylesheets/extra.61026d2ee9f4.css`:
- Around line 60-84: The second `@media` block in extra.61026d2ee9f4.css is
missing a closing brace, leaving the nested rules under .md-nav--lifted >
.md-nav__list unbalanced. Add the missing closing brace for
.md-nav__item--bosh-persistent in the `@media` screen and (min-width: 76.25em)
section, then ensure the .md-nav--lifted > .md-nav__list block and the `@media`
block both close properly.
- Around line 61-63: The lifted nav padding rule is using the wrong :has()
target, so it never matches the sticky-bottom item. Update the selector inside
.md-nav--lifted > .md-nav__list to use the same sticky-bottom class as the item
defined below, i.e. keep the selector consistent with
.md-nav__item--bosh-sidebar-sticky-bottom so the padding-bottom style applies
correctly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: b1b068cf-f57c-458c-b84e-7dcbd7582056
⛔ Files ignored due to path filters (2)
content/images/logo-full-white.pngis excluded by!**/*.pngcontent/images/logo-full.pngis excluded by!**/*.png
📒 Files selected for processing (3)
mkdocs.ymltheme/assets/stylesheets/extra.61026d2ee9f4.csstheme/partials/nav-item.html
💤 Files with no reviewable changes (1)
- mkdocs.yml
github-project-automation
Bot
moved this from Pending Merge | Prioritized
to Waiting for Changes | Open for Contribution
in Foundational Infrastructure Working Group
Fix problems found by code review AI. Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
github-project-automation
Bot
moved this from Waiting for Changes | Open for Contribution
to Pending Merge | Prioritized
in Foundational Infrastructure Working Group
Contributor
Author
|
Hi @neddp, thanks suggestion - I've applied the color suggestions and exported a new "dark theme" logo. Both this PR and cloudfoundry/bosh-io-web#81 are now ready for review.
Sure, I can work on a separate PR for this (and a few other link-related issues) after this one's merged. |
Member
|
Can you share some before/after screenshots? |
There was a problem hiding this comment.
Pull request overview
Upgrades the documentation site to Material for MkDocs 9.7.6, migrating MkDocs configuration and reducing local theme overrides to better align with upstream templates and features (e.g., tabs/footer, edit action, code copy, and dark mode).
Changes:
- Upgrade the MkDocs Material runtime (CI + local dev instructions) to
9.7.6. - Migrate
mkdocs.ymlto newer Material/MkDocs config conventions (features, analytics, palette toggles, nav links). - Remove most theme partial overrides and update remaining overrides/CSS to fit the new theme behavior (including light/dark logo assets on the homepage).
Reviewed changes
Copilot reviewed 10 out of 12 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| theme/partials/tabs.html | Removes old tabs override (now relying on upstream Material behavior). |
| theme/partials/source.html | Removes old repo/source link override (now configured via mkdocs.yml). |
| theme/partials/nav.html | Removes old primary nav override (now relying on upstream Material behavior). |
| theme/partials/nav-item.html | Replaces nav item rendering with a newer macro-based template. |
| theme/partials/footer.html | Removes old footer override (now relying on upstream Material footer). |
| theme/assets/stylesheets/extra.61026d2ee9f4.css | Updates/extends site-specific CSS, including sidebar behavior. |
| README.md | Updates local dev Docker image tag to 9.7.6. |
| mkdocs.yml | Migrates config to Material 9.x conventions (nav/features/palette/analytics/social/copyright). |
| content/index.md | Adds light/dark-mode specific logo images. |
| ci/tasks/build.yml | Updates CI image tag to 9.7.6. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Apply fixes found by copilot code review Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
Contributor
Author
@selzoc I've added before-and-afters. Except for the CSS nesting, I've applied Copilot Code Review's suggestions. |
Contributor
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
theme/assets/stylesheets/extra.61026d2ee9f4.css (1)
5-7: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winUse a theme-aware border color for blockquotes
rgba(0,0,0,.18)stays too dim inslate;--md-default-fg-color--lighteris defined in bothdefaultandslate, so switching the border to that token keeps the accent visible in both palettes.🤖 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 `@theme/assets/stylesheets/extra.61026d2ee9f4.css` around lines 5 - 7, Update the blockquote styling in extra.css so the border color is theme-aware instead of hardcoded; replace the fixed rgba value in the blockquote rule with the shared palette token used by both themes. Use the existing blockquote selector in the stylesheet and switch the border-left color to --md-default-fg-color--lighter so the accent remains visible in both default and slate themes.
🤖 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.
Outside diff comments:
In `@theme/assets/stylesheets/extra.61026d2ee9f4.css`:
- Around line 5-7: Update the blockquote styling in extra.css so the border
color is theme-aware instead of hardcoded; replace the fixed rgba value in the
blockquote rule with the shared palette token used by both themes. Use the
existing blockquote selector in the stylesheet and switch the border-left color
to --md-default-fg-color--lighter so the accent remains visible in both default
and slate themes.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 5e120b4f-7806-4c11-90ae-b3983dc3a2c2
📒 Files selected for processing (2)
theme/assets/stylesheets/extra.61026d2ee9f4.csstheme/partials/nav-item.html
neddp
approved these changes
Jul 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note
This must be merged in tandem with cloudfoundry/bosh-io-web#81 to prevent a broken website deploy.
This brings the docs up to date with the latest version of Material for MkDocs (v9.7.6):
Noticeable benefits are mostly niceities:
mkdocs.ymlconfig and templates are now aligned with the Material for MKDocs documentationScreenshot Comparisons
Home Page
Before:
After (Light):
After (Dark):
Docs Page
Before:
After (Light):
After (Dark):
The remaining screenshots are handled by the sister PR cloudfoundry/bosh-io-web#81:
Stemcells (All) Page
Before:
After (Light):
After (Dark):
Stemcells (Single) Page
Before:
After (Light):
After (Dark):
Releases Index Page
Before:
After (Light):
After (Dark):
Releases Show Versions Page
Before:
After (Light):
After (Dark):
Releases Show Version Page
Before:
After (Light):
After (Dark):
Package Page
Before:
After (Light):
After (Dark):
Job Page
Before:
After (Light):
After (Dark):
Mobile Sidebar (Depth: 1)
Before:
After (Light):
After (Dark):
Mobile Sidebar (Depth: 0)
Before:
After (Light):
After (Dark):
