Skip to content

Conversation

@radheshpai87
Copy link

@radheshpai87 radheshpai87 commented Nov 15, 2025

docs(examples): document pnpm/yarn usage in example READMEs

Summary

This PR updates multiple example README.md files under examples/ to include pnpm and yarn alternatives alongside the existing npm instructions. The repository uses pnpm workspaces; adding explicit pnpm instructions improves the developer experience and reduces friction for contributors following the monorepo workflow.

Changes

Updated the following files to add pnpm/yarn install & run variants:

  • examples/material-ui-vite/README.md
  • examples/joy-ui-cra-ts/README.md
  • examples/material-ui-gatsby/README.md
  • examples/material-ui-nextjs-pages-router/README.md
  • examples/material-ui-pigment-css-nextjs-ts/README.md
  • examples/joy-ui-nextjs-ts/README.md
  • examples/material-ui-remix-ts/README.md
  • examples/material-ui-vite-ts/README.md
  • examples/material-ui-vite-tailwind-ts/README.md
  • examples/material-ui-pigment-css-vite-ts/README.md
  • examples/material-ui-nextjs/README.md
  • examples/material-ui-nextjs-pages-router-ts/README.md
  • examples/material-ui-nextjs-ts/README.md
  • examples/material-ui-nextjs-ts-v4-v5-migration/README.md
  • examples/material-ui-preact/README.md
  • examples/material-ui-react-router-ts/README.md
  • examples/joy-ui-vite-ts/README.md
  • examples/material-ui-express-ssr/README.md

Note: these are documentation-only changes (README updates) and do not affect runtime code, tests, or build scripts.

Reason to change

  • The monorepo uses pnpm workspaces as the package manager for developer workflows.
  • Many example READMEs only mention npm, which can confuse contributors who expect pnpm when working in the monorepo.
  • Adding pnpm (and optionally yarn) alternatives is a low-risk, high-value developer experience improvement.

Checklist

  • PR title follows conventional commits style
  • Changes limited to documentation

@radheshpai87 radheshpai87 changed the title PR: docs(examples): document pnpm/yarn usage in example READMEs docs(examples): document pnpm/yarn usage in example READMEs Nov 15, 2025
@mui-bot
Copy link

mui-bot commented Nov 15, 2025

Netlify deploy preview

https://deploy-preview-47268--material-ui.netlify.app/

Bundle size report

Bundle Parsed size Gzip size
@mui/material 0B(0.00%) 0B(0.00%)
@mui/lab 0B(0.00%) 0B(0.00%)
@mui/system 0B(0.00%) 0B(0.00%)
@mui/utils 0B(0.00%) 0B(0.00%)

Details of bundle changes

Generated by 🚫 dangerJS against e701bc3

@mj12albert mj12albert closed this Nov 16, 2025
@radheshpai87 radheshpai87 deleted the docs/examples/add-pnpm-to-readmes branch November 16, 2025 03:54
@zannager zannager added docs Improvements or additions to the documentation. examples Relating to /examples. labels Nov 17, 2025
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. examples Relating to /examples.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants