Skip to content

chore: upgrade docusaurus from 3.2.1 to 3.7.0 #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

markrickert
Copy link
Member

To do this upgrade, I generated a brand new docusarus project with their cli tool, copied over all the relevant content to this new instance & ensured everything worked.

Then deleted the primary instance’s files, copied over the upgraded instance’s files, and compared the git diffs. Turns out that there weren’t that many changes needed.

The babel customization file didn’t need to be there (it’s on by default) and many of the packages listed in the package.json are no longer needed.

To do this upgrade, i generated a brand new docusarus project with their cli tool, copied over all the relevant content to this new instance & ensured everything worked. Then deleted the primary instance’s files, copied over the upgraded instance’s files, and compared the git diffs.

Turns out that there weren’t that many needed changes.

the babel customization file didn’t need to be there (it’s on by default) and many of the packages listed in the package.json are no longer needed.
Copy link

@Copilot 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

This PR upgrades Docusaurus from 3.2.1 to 3.7.0 and cleans up unnecessary configuration and dependency files.

  • Upgraded core Docusaurus dependencies and related packages in package.json
  • Updated docusaurus.config.ts to align with new dependency versions and improved type definitions
  • Removed the unused babel.config.js file to simplify project configuration

Reviewed Changes

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

File Description
package.json Upgraded Docusaurus dependencies and removed unused packages
docusaurus.config.ts Updated type annotations and comment wording to match upgrades
babel.config.js Removed obsolete file no longer needed with new Docusaurus version
Comments suppressed due to low confidence (2)

package.json:25

  • Upgrading React to version 19 may introduce breaking changes; please ensure compatibility with Docusaurus and existing usage in your project.
"react": "^19.0.0",

package.json:23

  • The upgrade to clsx version 2 may involve API changes; please verify that all existing usages in the project conform to the updated API.
"clsx": "^2.0.0",

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