Skip to content

chore: upgrade to MkDocs NG 1.11.0 and Material 9.8.0 - #72

Merged
shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-f1224c
Nov 4, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-f1224c

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Nov 4, 2026 •

Copy link
Copy Markdown
Member

Bumps the docs toolchain to the current MkDocs NG releases:

  • mkdocs-ng-material[imaging] 9.7.7 → 9.8.0
  • pin mkdocs-ng==1.11.0 explicitly (the live site was built with 1.9.0, whatever the Material pin resolved to)

Theme, plugins (blog, social) and content are unchanged.

Checked locally:

  • mkdocs build --strict passes; generator meta is mkdocs-1.11.0, mkdocs-material-9.8.0; 55 pages, social cards still rendered
  • python -m pytest tests/ -q with the released commit-check: 18 passed, so pins and changelog are in step with PyPI

Branch name doesn't follow the chore/... convention because of a tooling limitation on my side.

Summary by CodeRabbit

  • Chores
    • Refreshed the documentation site’s build setup with updated tooling versions. The change is limited to documentation configuration and does not alter application behavior, user-facing features, or public interfaces.

Pin mkdocs-ng itself as well, so the build no longer picks up whatever
version mkdocs-ng-material happens to resolve to.
@netlify

netlify Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit 71099af
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6aeb0a6c42b008e7ceb9667d
😎 Deploy Preview https://deploy-preview-72--commit-check.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The documentation requirements pin mkdocs-ng to 1.11.0 and update mkdocs-ng-material[imaging] to 9.8.0.

Changes: Documentation dependencies

Layer / File(s) Summary
Update documentation requirements
docs/requirements.txt
The requirements add mkdocs-ng==1.11.0 and update mkdocs-ng-material[imaging] from 9.7.7 to 9.8.0.

Estimated code review effort: 2 (Simple) | ~5 minutes

Change: Other

Merge Risk: Minimal · up to 71099

The documentation dependency update has no identified merge-blocking issue and is mergeable subject to normal checks.

Pre-merge checks: Passed 4
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely identifies the main change: upgrading MkDocs NG to 1.11.0 and Material to 9.8.0.
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)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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
Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: a30bae82-0d1a-4180-a703-e90f4185eedd
Commits

Reviewing files that changed from the base of the PR and between 5542d8b and 71099af.

Files selected for processing: 1
  • docs/requirements.txt

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@shenxianpeng
shenxianpeng merged commit 5b562e9 into main Nov 4, 2026
8 checks passed
@shenxianpeng
shenxianpeng deleted the claude/project-thread-f1224c branch November 4, 2026 10:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant