chore: add a different way for pnpm to manage nodejs version, because users may not want to download other packages. #4786
Conversation
ArthurDarkstone
requested review from
anncwb,
vince292007 and
a team
as code owners
|
WalkthroughThe pull request updates the "Quick Start" guide documentation to specify a more precise Node.js version requirement, changing it from "version 20 or above" to "version 20.15.0 or above." Additionally, it expands the options for Node.js version management by including "pnpm" alongside "fnm" and "nvm." The remaining content of the document remains unchanged, focusing on environment requirements, source code acquisition, dependency installation, and project execution. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
ArthurDarkstone
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (2)
docs/src/guide/introduction/quick-start.md (1)
13-13: Enhance documentation for pnpm version management.While adding pnpm as a version manager is helpful, it would be more user-friendly to include a brief example of how to use
pnpm envfor Node.js version management.Consider adding:
- [pnpm](https://pnpm.io/cli/env) 进行版本管理。 + [pnpm](https://pnpm.io/cli/env) 进行版本管理 (使用 `pnpm env use --global 20.15.0` 安装并切换版本)。docs/src/en/guide/introduction/quick-start.md (1)
13-13: Clarify pnpm version management capabilities.While adding pnpm as a version manager aligns with the PR objectives, it would be helpful to:
- Add a brief note explaining how pnpm manages Node.js versions differently from fnm/nvm
- Include example commands for managing Node.js versions with pnpm
Consider adding this after the current line:
- [Node.js](https://nodejs.org/en) version 20.15.0 or above. It is recommended to use [fnm](https://github.com/Schniz/fnm), [nvm](https://github.com/nvm-sh/nvm), or directly use [pnpm](https://pnpm.io/cli/env) for version management. + [Node.js](https://nodejs.org/en) version 20.15.0 or above. It is recommended to use [fnm](https://github.com/Schniz/fnm), [nvm](https://github.com/nvm-sh/nvm), or directly use [pnpm](https://pnpm.io/cli/env) for version management. + + To manage Node.js versions with pnpm: + ```bash + # Use pnpm env to manage Node.js versions + pnpm env use --global 20.15.0 + ```
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
docs/src/en/guide/introduction/quick-start.md(1 hunks)docs/src/guide/introduction/quick-start.md(1 hunks)
anncwb
changed the title
… users may not want to download other packages. (vbenjs#4786) * docs: add a way for pnpm to manage nodejs version * docs: add a way for pnpm to manage nodejs version --------- Co-authored-by: liliang18 <[email protected]>
Description
Type of change
Please delete options that are not relevant.
pnpm-lock.yamlunless you introduce a new test example.Checklist
pnpm run docs:devcommand.pnpm test.feat:,fix:,perf:,docs:, orchore:.Summary by CodeRabbit