[WIP] Refactor docusaurus-openapi plugin #47
Closed
Conversation
This file contains 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
|
Size Change: -437 kB (-17%) 👏 Total Size: 2.08 MB
ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 594d766): https://docusaurus-openapi-36b86--pr47-9r6n85sx.web.app (expires Fri, 13 May 2022 20:55:00 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
|
Using this PR for tracking purposes only as changes already merged via #48. |
|
🎉 Achievement unlocked. 🎉 |
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.
Description
Major refactor of
docusaurus-openapi:sidebarsanddocsmodules.docusaurus-plugin-openapinow writes MDX files toplugin-content-docspath.ApiItemnow supports allplugin-content-docsfeatures, including breadcrumbs, pagination, TOC, etc.SidebarGeneratoror custom sidebar slicesRemaining items to implement:
sidebarOptionswithgroupByTagssupport #53Motivation and Context
Although nearing “feature complete”, our current OpenAPI docs solution is highly susceptible and vulnerable to breaking changes introduced by new Docusaurus releases. Such changes impede our ability to upgrade Docusaurus in order to take advantage of bug fixes and new features. Overcoming these breaking changes requires additional development work on our part in order to refactor our plugin for compatibility with the new Docusaurus release.
How Has This Been Tested?
Screenshots (if appropriate)
Types of changes
Checklist