Skip to content

chore: upgrade Docusaurus to 3.10.0#2533

Merged
aeneasr merged 1 commit intomasterfrom
aeneasr/update-docusaurus-bdybv
Apr 28, 2026
Merged

chore: upgrade Docusaurus to 3.10.0#2533
aeneasr merged 1 commit intomasterfrom
aeneasr/update-docusaurus-bdybv

Conversation

@aeneasr
Copy link
Copy Markdown
Member

@aeneasr aeneasr commented Apr 28, 2026

Summary

  • Bumps all 8 @docusaurus/* packages from 3.9.2 → 3.10.0 (one minor release; npm latest).
  • Migrates onBrokenMarkdownLinks from the top-level config to markdown.hooks.onBrokenMarkdownLinks — the old location now logs a deprecation warning in 3.10 and is removed in v4.
  • Out of scope: opt-in adoption of @docusaurus/faster (Rspack), v4 future flags, and other dep updates.

Test plan

  • npm install clean — no peer-dep warnings; redocusaurus 2.5.0 / docusaurus-theme-redoc 2.5.0 resolve against 3.10.0
  • npm run build succeeds; build/welcome.html is 209 KB with navbar, sidebar, footer, Algolia, and Kapa markers intact
  • CSS-preload plugin (src/plugins/preload-css.js) still inlines the styles.*.css chunk (~186 KB style block in welcome.html)
  • npm run start boots cleanly, compile in ~44s, no errors
  • Smoke routes return 200: /docs/welcome, /docs/getting-started/local-development, /docs/reference/api, /docs/kratos/quickstart
  • Redoc API page renders (build/reference/api.html 193 KB)
  • Verified the two swizzled components that import from @docusaurus/theme-common/internal (NavbaruseNavbarMobileSidebar, DocSidebarItem/CategoryisSamePath) are unaffected by 3.10's Tabs context refactor
  • CI: build, static_checks, argos (visual regression), playwright

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Chores
    • Updated framework dependencies to version 3.10.0, including core components and plugins for improved compatibility and performance.

Bumps all @docusaurus/* packages from 3.9.2 to 3.10.0 and migrates
onBrokenMarkdownLinks to its new home under markdown.hooks (the
top-level option is deprecated in 3.10 and removed in v4).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 28, 2026 13:38
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 28, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 70db3dea-ddfc-46ab-8c34-991adf2e8a8a

📥 Commits

Reviewing files that changed from the base of the PR and between 8134465 and 8c72bb3.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (2)
  • docusaurus.config.ts
  • package.json

📝 Walkthrough

Walkthrough

This pull request updates the Docusaurus configuration to use the new markdown hooks system for broken link handling, and upgrades eight Docusaurus packages from version 3.9.2 to 3.10.0 in the project dependencies.

Changes

Cohort / File(s) Summary
Configuration Refactoring
docusaurus.config.ts
Migrated broken markdown link handling from top-level onBrokenMarkdownLinks setting to the markdown.hooks.onBrokenMarkdownLinks hook, maintaining the "warn" level.
Dependency Upgrade
package.json
Upgraded eight Docusaurus packages (@docusaurus/core, plugin-client-redirects, plugin-content-docs, plugin-content-pages, plugin-sitemap, preset-classic, theme-classic, theme-search-algolia) from version 3.9.2 to 3.10.0.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 The hooks now flow where config once stood,
Docusaurus hops to version good!
Dependencies leap, from nine-point-two,
To shiny three-ten, refactored anew! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'chore: upgrade Docusaurus to 3.10.0' accurately summarizes the primary change: a dependency upgrade to Docusaurus 3.10.0 across all related packages.
Description check ✅ Passed The description comprehensively documents the changes (package upgrades and config migration), includes a detailed test plan with passing results, and clearly defines scope boundaries. It meets the template's requirements for communicating the change rationale.
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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch aeneasr/update-docusaurus-bdybv

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 and usage tips.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Upgrades the documentation site to Docusaurus 3.10.0 and updates configuration to match the new markdown link-checking hook location.

Changes:

  • Bump all @docusaurus/* dependencies from 3.9.23.10.0.
  • Migrate onBrokenMarkdownLinks from top-level config to markdown.hooks.onBrokenMarkdownLinks to avoid the 3.10 deprecation path / v4 removal.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

File Description
package.json Updates all Docusaurus package versions to 3.10.0.
docusaurus.config.ts Moves broken-markdown-link handling into markdown.hooks per 3.10+ config structure.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Member

@vinckr vinckr left a comment

Choose a reason for hiding this comment

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

lgtm

@aeneasr aeneasr merged commit c8d3c89 into master Apr 28, 2026
19 checks passed
@aeneasr aeneasr deleted the aeneasr/update-docusaurus-bdybv branch April 28, 2026 13:57
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.

4 participants