Skip to content
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

Upgrade to Docusaurus v3 #37

Merged
merged 3 commits into from
Nov 9, 2023
Merged

Upgrade to Docusaurus v3 #37

merged 3 commits into from
Nov 9, 2023

Conversation

tukib
Copy link
Member

@tukib tukib commented Nov 7, 2023

Note

Upgrading multiple packages rather than in sequence is an exception to our current policy. The justification for this is that Docusaurus v3 directly requires our MDX and React versions to match. Attempting to upgrade these separately may cause issues and additional overhead.

All dependencies below are already at their latest minor & patch version. Resolves #34

Dependency Current New
@docusaurus/core ^2.4.3 ^3.0.0
@docusaurus/plugin-content-docs ^2.4.3 ^3.0.0
@docusaurus/theme-classic ^2.4.3 ^3.0.0
@mdx-js/react ^1.6.22 ^3.0.0
react ^17.0.2 ^18.2.0
Dev Dependency Current New
@docusaurus/module-type-aliases ^2.4.3 ^3.0.0
@docusaurus/theme-common ^2.4.3 ^3.0.0
@docusaurus/types ^2.4.3 ^3.0.0
@docusaurus/tsconfig none ^3.0.0
@tsconfig/docusaurus ^2.0.1 removed
@types/react none ^18.2.36
  • @tsconfig/docusaurus does not explicitly support v3, so it has been replaced by @docusaurus/tsconfig. Recommened by Docusaurus v3 documentation: TypeScript Support
  • Adding @types/react as this saves some overhead of adding it later when we inevitably use react directly.

Upgrade Guides:

@tukib tukib requested a review from a team as a code owner November 7, 2023 12:53
@tukib tukib mentioned this pull request Nov 7, 2023
3 tasks
Copy link
Member

@seanmakesgames seanmakesgames left a comment

Choose a reason for hiding this comment

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

Build worked correctly. Landing page loaded fine in a codespace.

Thank you for writing up the 'note' at the beginning of the PR. When I saw all the changes and also saw 'using the upgrade policy'; I was like -- no! haha

Just some comments / questions for the settings. Left inline. Probably we want @danswann to take a look at this PR before merging it.

docusaurus.config.js Show resolved Hide resolved
docusaurus.config.js Show resolved Hide resolved
docusaurus.config.js Show resolved Hide resolved
docusaurus.config.js Outdated Show resolved Hide resolved
Co-authored-by: Bryn Ward-Leikis <ward.leikis@gmail.com>
@tukib tukib merged commit 61ca45a into main Nov 9, 2023
3 checks passed
@tukib tukib deleted the tukib/docusaurus-v3 branch November 9, 2023 11:54
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.

Upgrade Docusaurus from ^2.4.3 to ^3.0.0
3 participants