Skip to content

chore(deps): upgrade to mkdocs-material@9.7.6#908

Open
achrinza wants to merge 1 commit into
cloudfoundry:masterfrom
achrinzafork:chore/upgrade-mkdocs
Open

chore(deps): upgrade to mkdocs-material@9.7.6#908
achrinza wants to merge 1 commit into
cloudfoundry:masterfrom
achrinzafork:chore/upgrade-mkdocs

Conversation

@achrinza

Copy link
Copy Markdown
Contributor

This brings the docs up to date with the latest version of Material for MkDocs (v9.7.6):

  • Migrated config
  • Migrated theme overrides

Noticeable benefits are mostly niceities:

  • mkdocs.yml config and templates are now aligned with the Material for MKDocs documentation
  • Better code block highlighting
  • Dark mode

See also the accompanying PR: cloudfoundry/bosh-io-web#81

@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@achrinza, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 49 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 193ff561-d10e-4132-aa5f-a3931f0e6793

📥 Commits

Reviewing files that changed from the base of the PR and between ad38b48 and a896a9b.

⛔ Files ignored due to path filters (1)
  • content/images/logo-full-white.png is excluded by !**/*.png
📒 Files selected for processing (10)
  • README.md
  • ci/tasks/build.yml
  • content/index.md
  • mkdocs.yml
  • theme/partials/copyright.html
  • theme/partials/footer.html
  • theme/partials/nav-item.html
  • theme/partials/nav.html
  • theme/partials/source.html
  • theme/partials/tabs.html

Walkthrough

The pull request upgrades the squidfunk/mkdocs-material Docker image from 2.7.2 to 9.7.6 across the CI build task and README. mkdocs.yml is migrated to the Material 9.x configuration API: repository metadata fields are added, the pages: key is replaced with nav:, theme features and light/dark palette toggles are reconfigured, and Google Analytics configuration is replaced with an extra.analytics block using !ENV. Custom theme partials are rewritten to match the new API: nav.html and tabs.html switch to macro-based rendering over nav.items; nav-item.html is refactored into reusable Jinja macros with recursive rendering; footer.html adopts feature-flag-gated navigation links; copyright.html is added as a new partial; and source.html becomes config-driven.

Suggested reviewers

  • aramprice
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: upgrading mkdocs-material to 9.7.6.
Description check ✅ Passed The description is directly related to the changeset and summarizes the config and theme migration work.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between d013e9f and ad38b48.

⛔ Files ignored due to path filters (1)
  • content/images/logo-full-white.png is excluded by !**/*.png
📒 Files selected for processing (10)
  • README.md
  • ci/tasks/build.yml
  • content/index.md
  • mkdocs.yml
  • theme/partials/copyright.html
  • theme/partials/footer.html
  • theme/partials/nav-item.html
  • theme/partials/nav.html
  • theme/partials/source.html
  • theme/partials/tabs.html

Comment thread mkdocs.yml
Comment thread theme/partials/nav-item.html
Comment thread theme/partials/tabs.html
- Migrated config
- Migrated theme overrides

Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
@achrinza achrinza force-pushed the chore/upgrade-mkdocs branch from ad38b48 to a896a9b Compare June 30, 2026 08:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Pending Merge | Prioritized

Development

Successfully merging this pull request may close these issues.

1 participant