-
Notifications
You must be signed in to change notification settings - Fork 224
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] Docusaurus Beta 22 support #155
Conversation
Visit the preview URL for this PR (updated for commit 631557e): https://docusaurus-openapi-36b86--pr155-hdpr1rk6.web.app (expires Fri, 12 Aug 2022 02:02:18 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
Size Change: -101 kB (-3%) Total Size: 3.28 MB
ℹ️ View Unchanged
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Built and tested locally - works great. Great job with the refactor! Feel free to pass any feedback on the upgrade experience to Sebastien and team if you think it could help.
Description
This PR introduces support for Docusaurus
2.0.0-beta.22
. The following breaking changes have been resolved:DocItemFooter
component to the following path@theme/DocItem/Footer
and removing previously passed down propsApiItem
withDocProvider
CodeTabs
,ApiTabs
, andSchemaTabs
utils that have been moved into@docusaurus/theme-common/internal
moduleTODO
ApiItem
into smaller subcomponents, similar to https://github.com/facebook/docusaurus/tree/main/packages/docusaurus-theme-classic/src/theme/DocItemMotivation and Context
Provide support and compatibility with the latest version of Docusaurus. In addition, refactoring of the
ApiItem
into smaller components increases the ease of maintainability and may prevent further breaking changes in the future.How Has This Been Tested?
Tested deployed preview against the live site to ensure that there weren't any significant changes, unexpected behaviors, and all components that were refactored are functionally intact. From the UI perspective, all styles should remain consistent and unchanged prior to refactor.
Screenshots (if appropriate)
Types of changes
Checklist