-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
fix(docs): yarn global command in installation page #4013
Conversation
Update yarn command to install nextui-cli because yarn add -g ... doesnt work and needs to use yarn add global
|
@clementvt is attempting to deploy a commit to the NextUI Inc Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe pull request modifies the installation instructions for NextUI, specifically updating the Yarn command for global installation from Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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
Documentation and Community
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
apps/docs/content/docs/guide/installation.mdx (1)
29-29
: LGTM! Consider adding a version note for clarity.The update from
yarn add -g
toyarn add global
is correct and fixes the installation error with recent Yarn versions.Consider adding a version note for additional clarity:
- yarn: "yarn add global nextui-cli", + yarn: "yarn add global nextui-cli", // For Yarn 2+ (Berry)
Sorry it's my first contribution, I don't know if I'm doing it right or if it has already been solved ( I searched if issue was already reported but didn't found anything ) |
Thanks! @clementvt |
Docs update:
Update yarn command to install nextui-cli because
yarn add -g <package>
doesnt work and needs to useyarn add global <package>
📝 Description
⛳️ Current behavior (updates)
Modify the yarn installation script to not throw error
🚀 New behavior
New script doesn't throws error with the latest version of yarn installed
💣 Is this a breaking change (Yes/No):
No.
📝 Additional Information
Summary by CodeRabbit