Skip to content

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

Open
achrinza wants to merge 4 commits into
cloudfoundry:masterfrom
achrinzafork:chore/upgrade-mkdocs
Open

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

Conversation

@achrinza

@achrinza achrinza commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

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):

  • Migrated config
  • Migrated theme overrides

Noticeable benefits are mostly niceities:

  • Reduced tech debt
    • mkdocs.yml config and templates are now aligned with the Material for MKDocs documentation
    • Reduced theme override files from 5 to 1
  • Better code block highlighting
  • Dark mode

@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

This pull request upgrades the squidfunk/mkdocs-material Docker image from 2.7.2 to 9.7.6, updating references in the CI build task and README. It migrates mkdocs.yml to the new theme configuration format (repo metadata, nav key, light/dark palette toggles, markdown_extensions, analytics/social via extra config). Custom theme partials (nav-item, nav, footer, tabs, source) are rewritten to match the Material 9.x template API using macros and feature-flag-driven rendering. A themed logo pair is added to content/index.md, and a new CSS rule styles the copyright highlight.

Suggested reviewers

aramprice

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: upgrading mkdocs-material to 9.7.6.
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.
Description check ✅ Passed The description matches the changeset by describing the MkDocs Material upgrade, config migration, and theme override updates.
✨ 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
Contributor

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 Outdated
- 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
coderabbitai[bot]
coderabbitai Bot previously approved these changes Jun 30, 2026
Use newer Material for MkDocs features to reduce reliance on custom theme overrides.

Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

📥 Commits

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

⛔ 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/assets/stylesheets/extra.61026d2ee9f4.css
  • theme/partials/footer.html
  • theme/partials/nav-item.html
  • theme/partials/nav.html
  • theme/partials/source.html
  • theme/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

Comment thread mkdocs.yml
Comment thread theme/partials/nav-item.html
@github-project-automation github-project-automation Bot moved this from Pending Merge | Prioritized to Waiting for Changes | Open for Contribution in Foundational Infrastructure Working Group Jul 1, 2026
achrinza added 2 commits July 1, 2026 21:39
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 github-project-automation Bot moved this from Waiting for Changes | Open for Contribution to Pending Merge | Prioritized in Foundational Infrastructure Working Group Jul 1, 2026
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