chore(website): upgrade Docusaurus from v2 to v3#235
Open
Conversation
Upgrade `@docusaurus/core` from 2.4.3 to 3.10.0 along with all related dependencies (React 18, MDX v3, `prism-react-renderer` v2). Update `prism-react-renderer` import syntax in `docusaurus.config.js`, rename `Frameworks`/`Operations` doc folders to lowercase for case-sensitive routing in v3, add Vercel redirects for old paths, and override `webpackbar` to v7 to fix webpack 5.106 compatibility.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Upgrades the Docusaurus website from v2 to v3, aligning the site with newer React/MDX/Prism dependencies and updating docs routing to work reliably on case-sensitive deployments (plus redirects to preserve old URLs).
Changes:
- Upgrade Docusaurus-related dependencies (Docusaurus v3, React 18, MDX v3, prism-react-renderer v2, sass plugin).
- Update Prism theme import usage in
docusaurus.config.jsfor prism-react-renderer v2. - Normalize docs folder casing (
frameworks/,operations/) and add Vercel redirects for legacy uppercase routes.
Reviewed changes
Copilot reviewed 4 out of 16 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| packages/website/vercel.json | Adds redirects for legacy uppercase doc paths. |
| packages/website/package.json | Bumps website dependencies to Docusaurus v3 / React 18 / MDX v3 ecosystem. |
| packages/website/docusaurus.config.js | Updates Prism theme configuration to prism-react-renderer v2 API. |
| packages/website/docs/operations/category.json | Defines Operations docs category metadata. |
| packages/website/docs/operations/getting-started.md | Adds Operations “Getting Started” documentation page. |
| packages/website/docs/operations/android.md | Adds Android operations documentation page. |
| packages/website/docs/operations/ios.md | Adds iOS operations documentation page. |
| packages/website/docs/operations/project.md | Adds project-level operations documentation page. |
| packages/website/docs/frameworks/category.json | Defines Frameworks docs category metadata. |
| packages/website/docs/frameworks/capacitor.md | Adds Capacitor framework guide. |
| packages/website/docs/frameworks/flutter.md | Adds Flutter framework guide. |
| packages/website/docs/frameworks/native-android.md | Adds Native Android framework guide. |
| packages/website/docs/frameworks/native-ios.md | Adds Native iOS framework guide. |
| packages/website/docs/frameworks/react-native.md | Adds React Native framework guide. |
| package.json | Adds npm override for webpackbar to address webpack compatibility. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Remove `jest` from `types` arrays (migrated to Vitest) and drop `@types/node` override (no longer needed with TypeScript 5.9).
…andalone` TS 5.9 requires type declarations for `prettier`. Add `@types/prettier` as a dev dependency and switch from the browser-only `prettier/standalone` to the standard `prettier` import (appropriate for this Node.js context).
The `should run operations` test runs Gradle parsing which requires Java and exceeds the 30s default timeout on CI runners.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
@docusaurus/corefrom 2.4.3 to 3.10.0 with all related dependencies (React 18, MDX v3,prism-react-rendererv2,docusaurus-plugin-sass0.2.6)prism-react-rendererimport syntax indocusaurus.config.jsto v2 APIFrameworks/Operationsdoc folders to lowercase for case-sensitive routing in Docusaurus v3webpackbarv7 override in rootpackage.jsonto fix compatibility with webpack 5.106Test plan
npx docusaurus buildcompletes successfully