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: Add pnpm version requirement notice to README #1681

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

AngeloSchulerPiletti
Copy link

πŸ”— Linked issue

I've found no open issue about it

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

I attempted to run the documentation locally using pnpm 9.6.0 and followed all the basic instructions, but the page kept loading indefinitely. Before opening an issue, I noticed that my pnpm version didn't match the one specified in packageManager in package.json.

To prevent similar issues for others running the project locally, I've added a note in the README to clarify the importance of using the correct pnpm version. This should help avoid potential confusion and problems.

@AngeloSchulerPiletti AngeloSchulerPiletti changed the title Add pnpm version requirement notice to README docs: Add pnpm version requirement notice to README Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant