-
-
Notifications
You must be signed in to change notification settings - Fork 289
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
chore: allow to serve docs from root folder #6571
Conversation
d8fda02
to
bdbf3f8
Compare
bdbf3f8
to
5c5f5e6
Compare
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## unstable #6571 +/- ##
============================================
+ Coverage 61.46% 61.48% +0.02%
============================================
Files 556 556
Lines 58850 58891 +41
Branches 1850 1854 +4
============================================
+ Hits 36171 36212 +41
Misses 22638 22638
Partials 41 41 |
Performance Report✔️ no performance regression detected 🚀🚀 Significant benchmark improvement detected
Full benchmark results
|
@@ -21,6 +21,7 @@ | |||
"check-types": "lerna run check-types", | |||
"check-spelling": "pyspelling -c .pyspelling.yml -v", | |||
"docs:build": "lerna run check-readme && lerna run docs:build && ./scripts/prepare-docs.sh", | |||
"docs:serve": "yarn --cwd docs install && yarn --cwd docs start", |
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.
yarn --cwd docs install
will this part be a no-op if dependencies are already installed?
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.
Right, it will be almost instant and no-op (success Already up-to-date.
). I used this approach to have a single command to serve the docs, even the first time.
Co-authored-by: Nico Flaig <nflaig@protonmail.com>
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 good! Simple change that drastically improves dev experience
🎉 This PR is included in v1.18.0 🎉 |
Motivation
Allow to serve docs using
yarn docs:serve