chore(docusaurus): upgrade to v3.10.1 and migrate markdown hooks#533
chore(docusaurus): upgrade to v3.10.1 and migrate markdown hooks#533vanshika2720 wants to merge 1 commit into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Welcome @vanshika2720! It looks like this is your first PR to volcano-sh/website 🎉 |
There was a problem hiding this comment.
Code Review
This pull request upgrades Docusaurus dependencies to version 3.10.1, adds the @docusaurus/faster package, and configures markdown format detection. However, nesting onBrokenMarkdownLinks under markdown.hooks is incorrect as it is a top-level configuration option in Docusaurus, which would cause the setting to be ignored.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
a727c49 to
1a8fdf1
Compare
|
Just adding a bit of context on a few implementation details:
Build and locale checks completed successfully, and the deprecated |
hajnalmt
left a comment
There was a problem hiding this comment.
Thanks for the PR,
I am somewhat not understanding the description and the faster handling. I don't see docosaurus@faster in the dependency directly, you added it as a peerDependency, why to add the flag with false then? Shouldn't we add it with the correct version with the upgrade? Also * can break things for other people (if they switch the flag to true), because @docusaurus/faster is tightly coupled to core internals, eg.: a 3.9.x faster against a 3.10.1 core can break or behave oddly. You want it to match core exactly (3.10.1).
Otherwise I am okay with the PR 👍 Thank you!
|
|
||
| future: { | ||
| v4: true, | ||
| faster: false, |
There was a problem hiding this comment.
Is there an actual reason to set this if we don't enable it?
There was a problem hiding this comment.
@hajnalmt I tested removing it after your comment to verify whether it was still needed. The build fails without it because this repository already has future.v4: true, and in Docusaurus 3.10.x that enables the faster pipeline by default. Since this project doesn't include @docusaurus/faster as a dependency, the build errors unless future.faster is explicitly set to false.
So I kept the flag to preserve the current build behavior and added a short comment in the config explaining why it's there. This keeps the upgrade focused on the Docusaurus version bump without enabling the faster pipeline.
There was a problem hiding this comment.
Agh thanks for the clarification, I understand now.
| "node": ">=20.0" | ||
| }, | ||
| "peerDependencies": { | ||
| "@docusaurus/faster": "*", |
There was a problem hiding this comment.
Are we sure in this? Asterisk means any version here right?
There was a problem hiding this comment.
@hajnalmt The @docusaurus/faster: "*" entry in package-lock.json isn't something this PR adds or controls. It's inherited from @docusaurus/core's own package.json, where it's declared as an optional peer dependency.
Since it's generated by npm during lockfile regeneration, we can't pin or modify it in package-lock.json. If we decide to enable the faster pipeline in the future, we'd add @docusaurus/faster explicitly to package.json with the matching version (e.g. 3.10.1) so it stays aligned with the Docusaurus core version.
There was a problem hiding this comment.
I see thanks! It's alright this way then.
Signed-off-by: Vanshika <[email protected]>
1a8fdf1 to
3d2d277
Compare
|
@hajnalmt @JesseStutler please review |
|
|
||
| future: { | ||
| v4: true, | ||
| faster: false, |
There was a problem hiding this comment.
Agh thanks for the clarification, I understand now.
What kind of change does this PR introduce?
/kind cleanup
What this PR does / why we need it
This PR upgrades the website's Docusaurus dependencies from v3.9.2 to v3.10.1 and migrates the deprecated markdown link hook configuration to its new location.
These changes remove deprecation warnings from the build output, keep the project aligned with current Docusaurus recommendations, and improve compatibility with future Docusaurus v4 upgrades.
Changes
Dependency Upgrades
Upgraded the following packages to v3.10.1:
@docusaurus/core@docusaurus/preset-classic@docusaurus/module-type-aliases@docusaurus/typesAdditionally:
@docusaurus/[email protected]to align with the existingfuture.v4: trueconfiguration.Configuration Migration
Migrated the deprecated top-level configuration:
to the new Docusaurus-supported structure:
The
markdown.format: "detect"option allows standard.mdfiles to be parsed using CommonMark while preserving MDX support where needed, preventing MDX v3 parsing issues on regular markdown content.Verification
Installation
npm installcompleted successfullyBuild Validation
npm run buildnpm run build -- --locale ennpm run build -- --locale zh-HansConfiguration Validation
onBrokenMarkdownLinkswarnings during buildonBrokenMarkdownLinksconfiguration entriesWhich issue(s) does this PR fix?
#532
Fixes deprecated Docusaurus configuration warnings and prepares the documentation site for improved Docusaurus v4 compatibility.




