Skip to content
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

docs(readme): incorrect pnpm script #43206

Closed
Jay-Karia opened this issue Aug 6, 2024 · 1 comment
Closed

docs(readme): incorrect pnpm script #43206

Jay-Karia opened this issue Aug 6, 2024 · 1 comment
Assignees
Labels
docs Improvements or additions to the documentation support: docs-feedback Feedback from documentation page

Comments

@Jay-Karia
Copy link
Contributor

Jay-Karia commented Aug 6, 2024

Related page

https://github.com/mui/material-ui/blob/next/CONTRIBUTING.md

Kind of issue

Other

Issue description

Here: https://github.com/mui/material-ui/blob/next/CONTRIBUTING.md#trying-changes-on-the-documentation-site
there is a pnpm script mentioned to start the development server: pnpm start which is incorrect. It should be rather pnpm dev.

We use pnpm start after building the application.

Context

This is mentioned in CONTRIBUTING.md file.
We have to use pnpm dev to start the local development server.

Search keywords: pnpm, docs, readme

@Jay-Karia Jay-Karia added status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page labels Aug 6, 2024
@zannager zannager added the docs Improvements or additions to the documentation label Aug 7, 2024
@Janpot
Copy link
Member

Janpot commented Aug 7, 2024

The start script runs pnpm install && pnpm docs:dev. While it's a bit unusual to call this script start, it doesn't seem wrong to me. I'm not sure who is using this script, but I wouldn't want to mess with their muscle memory considering it's been there for at least six years as far as i can see.

@Janpot Janpot closed this as completed Aug 7, 2024
@zannager zannager removed the status: waiting for maintainer These issues haven't been looked at yet by a maintainer label Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation support: docs-feedback Feedback from documentation page
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants