-
Notifications
You must be signed in to change notification settings - Fork 76
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
Initial commit for Docusaurus integration #611
Conversation
…olution for react-dev-utils
Codecov Report
@@ Coverage Diff @@
## main #611 +/- ##
==========================================
- Coverage 63.26% 63.18% -0.08%
==========================================
Files 86 86
Lines 8230 8242 +12
==========================================
+ Hits 5207 5208 +1
- Misses 3023 3034 +11
Continue to review full report at Codecov.
|
* Adding doc stubs * Contribution guide * Adding documentation stubs for many sections * Some documentation * Working through first tutorial using defaults * Fixing up mephisto wut * Finishing first tutorial finally :) * Fixing after webpack updates, work on tutorial 2 * Double ii fix
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.
First pass looks good. We'll remove some of the boilerplate as we decide on content/usage for the blog and elsewhere.
Adds docusaurus v2 at
docs/web
.Run from root:
Note: for now I've copied over the markdown files into
docs/web/docs
. We can later on delete the other doc files when the migration is complete.TODOs:
BUG 1: react-dev-utils incompatibility between storybook and docusaurusstorybook requires this in
package.json
"resolutions":
... however docusaurus requires this in order to fix this issue + PR:
Status: Exploring alternative solutions for docusaurus, as react-dev-utils@12 introduces other breaking changes for storybook
Resolved. Added a yarn patch with the changes from this PR directly to version 11.0.4. In an ideal world this would have been fixed in react-dev-utils@11.0.5 and not in a major version bump.
Screenshots