Migrate MkDocs to MkDocs NG

[shenxianpeng]

Summary by CodeRabbit

• Chores
  • Updated documentation generation dependencies to utilize newer tooling versions.

[netlify]

✅ Deploy Preview for commit-check-github-io ready!

Name	Link
🔨 Latest commit	4ec0565
🔍 Latest deploy log	https://app.netlify.com/projects/commit-check-github-io/deploys/69fdace4a730ac000898d5d6
😎 Deploy Preview	https://deploy-preview-5--commit-check-github-io.netlify.app
📱 Preview on mobile	Toggle 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]

📝 Walkthrough

Walkthrough

The documentation requirements file is updated to replace standard MkDocs with mkdocs-ng and its material theme variant, while preserving other documentation-related packages.

Changes

Documentation Build Tool Update

Layer / File(s)	Summary
Dependency Update docs/requirements.txt	mkdocs and mkdocs-material are replaced with mkdocs-ng and mkdocs-ng-material.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A tool grows new fur, sleek and fresh,
From mkdocs to mkdocs-ng mesh,
Docs will build with modern grace,
Hopping through the docs space!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately reflects the main change: migrating documentation dependencies from MkDocs to MkDocs NG as evidenced by the removal of mkdocs/mkdocs-material and addition of mkdocs-ng/mkdocs-ng-material.
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.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch shenxianpeng-patch-1

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

docs/requirements.txt (1)

2-4: ⚡ Quick win

Pin all documentation dependency versions for reproducible builds.

The requirements.txt file contains 4 unpinned packages (lines 1-4). Unpinned dependencies risk non-deterministic CI/docs failures as package maintainers release updates.

Latest stable versions are available:

• markdown-gfm-admonition: 0.3.0
• mkdocs-ng: 1.7.2
• mkdocs-include-markdown-plugin: 7.2.2
• mkdocs-ng-material: 9.7.7

Suggested change

-markdown-gfm-admonition
-mkdocs-ng
-mkdocs-include-markdown-plugin
-mkdocs-ng-material
+markdown-gfm-admonition==0.3.0
+mkdocs-ng==1.7.2
+mkdocs-include-markdown-plugin==7.2.2
+mkdocs-ng-material==9.7.7

🤖 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 `@docs/requirements.txt` around lines 2 - 4, requirements.txt currently lists
documentation packages without pinned versions; update the four package entries
to their specific stable versions: set markdown-gfm-admonition to 0.3.0,
mkdocs-ng to 1.7.2, mkdocs-include-markdown-plugin to 7.2.2, and
mkdocs-ng-material to 9.7.7 so builds are reproducible; edit the lines
containing the package names (markdown-gfm-admonition, mkdocs-ng,
mkdocs-include-markdown-plugin, mkdocs-ng-material) to append the corresponding
"==<version>" pins and save the file.

🤖 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 `@docs/requirements.txt`:
- Around line 2-4: requirements.txt currently lists documentation packages
without pinned versions; update the four package entries to their specific
stable versions: set markdown-gfm-admonition to 0.3.0, mkdocs-ng to 1.7.2,
mkdocs-include-markdown-plugin to 7.2.2, and mkdocs-ng-material to 9.7.7 so
builds are reproducible; edit the lines containing the package names
(markdown-gfm-admonition, mkdocs-ng, mkdocs-include-markdown-plugin,
mkdocs-ng-material) to append the corresponding "==<version>" pins and save the
file.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cd951acf-3e70-414e-a18d-5d44943089dd

📥 Commits

Reviewing files that changed from the base of the PR and between 3fa3d3c and 4ec0565.

📒 Files selected for processing (1)

• docs/requirements.txt