-
-
Notifications
You must be signed in to change notification settings - Fork 32.3k
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
fix(docs): missing and incorrect scripts #43209
Conversation
Signed-off-by: Jay <jay.sanjay.karia@gmail.com>
Signed-off-by: Jay <jay.sanjay.karia@gmail.com>
Netlify deploy previewhttps://deploy-preview-43209--material-ui.netlify.app/ Bundle size report |
We don't have a |
You have referred the |
So we need to update the README of |
That README says to run it from the project root:
It's confusing though. I'd probably just say |
Yeah, At the end it's upto you. |
Signed-off-by: Jay <jay.sanjay.karia@gmail.com>
I'm ok with recommending |
Signed-off-by: Jay <jay.sanjay.karia@gmail.com>
Now it's |
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.
Ok for me. The main problem with the pnpm start
script is that it will try to run the docs site in production when run from the wrong folder. At least now the error will say "Command "docs:dev" not found" if run from the docs folder. Improved DX for first time contributors 👍
Closes #43208
Adds a missing script:
pnpm install
.Updates an incorrect script:
pnpm start
topnpm dev