Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the project’s setup documentation by recommending Node.js version managers and streamlining dependency installation.
- Added instructions and links for using
nvm/nvm-windowsandpnpm - Removed the
npm installoption, leaving onlypnpm install
Comments suppressed due to low confidence (1)
README.md:58
- [nitpick] Use Markdown link syntax for the repositories and capitalize 'Windows' for consistency, e.g.,
[nvm](https://github.com/nvm-sh/nvm)and[nvm-windows](https://github.com/coreybutler/nvm-windows).
NOTE: You can install nvm (UNIX - https://github.com/nvm-sh/nvm) or nvm-windows (windows - https://github.com/coreybutler/nvm-windows) to manage multiple node versions.
❌ Deploy Preview for egdev6-design-system failed.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the
README.mdfile to improve the installation instructions. It introduces recommendations for managing Node.js versions and simplifies dependency installation steps.Updates to installation instructions:
nvm(for UNIX) ornvm-windows(for Windows) to manage multiple Node.js versions, along with a link to the respective repositories. Also included a link to thepnpminstallation documentation for users who do not havepnpminstalled. ([README.mdR58-R60](https://github.com/Stack-and-Flow/design-system/pull/59/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R58-R60))npm installoption from the dependency installation section, leaving only thepnpm installcommand for simplicity and consistency. ([README.mdL68-L75](https://github.com/Stack-and-Flow/design-system/pull/59/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L68-L75))