-
Notifications
You must be signed in to change notification settings - Fork 75
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
Adding tutorial stubs to docusaurus #613
Conversation
Codecov Report
@@ Coverage Diff @@
## docusaurus #613 +/- ##
==============================================
- Coverage 63.24% 63.11% -0.13%
==============================================
Files 86 86
Lines 8230 8242 +12
==============================================
- Hits 5205 5202 -3
- Misses 3025 3040 +15
Continue to review full report at Codecov.
|
Looks good - liking the structure and organization. I've updated the OP with a screenshot of the high level categories in the side bar. |
.gitignore
Outdated
# Examples | ||
examples/simple_static_task/hydra_configs/conf/* | ||
!examples/simple_static_task/hydra_configs/conf/example.yaml | ||
!examples/simple_static_task/hydra_configs/conf/onboardiing_example.yaml |
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.
looks like a typo, extra "i" in "onboardiing"
@@ -26,7 +26,7 @@ | |||
"file-loader": "^6.0.0", | |||
"style-loader": "^0.23.0", | |||
"url-loader": "^2.0.1", | |||
"webpack": "^4.19.1", | |||
"webpack": "^5.0.0-rc.6", |
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.
I always thought this would be a big upgrade, glad it wasn't too bad
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.
Yeah the disruption is pretty minor across the board, I'm happy to help if downstream projects hit an issue after this lands.
* Initial commit for docusaurus integration * Get storybook working with docusaurus, since they shared a common resolution for react-dev-utils * Add all docs to Docusaurus * Move pregenerated docs into Archive, fix up image links, fix up docusaurus.config.js * Fix webpack5 and react-dev-utils incompat error * Fix broken link in quickstart * Hide the blog for now and make some basic updates to the homepage * Fix docusaurus build issue * Documentation for the Mephisto Review CLI and front-end build work (#612) * Add review CLI docs * Add more content * Add Contributos & Authors folder * Docs reorg * Update broken link * fix sidebar * Position quickstart at the top of the Guides sidebar * Sidebar and footer updates * Flesh out sidebar organization a bit more * fix broken links * Adding tutorial stubs to docusaurus (#613) * 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 * fix broken quickstart link * Almost finished with custom react tutorial * Unnecessary change Co-authored-by: Jack Urbanek <[email protected]>
Adds a number of pages intended to be filled out to complete my first pass of tutorial + how-to documentation.
High level categories: