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

fix(docs): yarn global command in installation page #4013

Merged
merged 1 commit into from
Nov 27, 2024

Conversation

clementvt
Copy link
Contributor

@clementvt clementvt commented Nov 7, 2024

Docs update:

Update yarn command to install nextui-cli because yarn add -g <package> doesnt work and needs to use yarn 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

  • Documentation
    • Updated installation instructions for NextUI, including a revised Yarn command for global installation.
    • Enhanced clarity in both automatic and manual installation sections, with detailed commands for various package managers.
    • Added notes on Tailwind CSS setup and compatibility of NextUI version 2 with React 18 or later.

Update yarn command to install nextui-cli because yarn add -g ... doesnt work and needs to use yarn add global
Copy link

changeset-bot bot commented Nov 7, 2024

⚠️ No Changeset found

Latest commit: 8bdb5d9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Nov 7, 2024

@clementvt is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Nov 7, 2024

Walkthrough

The pull request modifies the installation instructions for NextUI, specifically updating the Yarn command for global installation from yarn add -g nextui-cli to yarn add global nextui-cli. The document retains its structure, detailing both automatic and manual installation methods, and includes guidance on setting up Tailwind CSS and using the NextUIProvider. It also clarifies compatibility requirements for NextUI version 2 with React 18 or later.

Changes

File Path Change Summary
apps/docs/content/docs/guide/installation.mdx Updated Yarn installation command from yarn add -g nextui-cli to yarn add global nextui-cli. Maintained structure for automatic and manual installation instructions, added notes on Tailwind CSS setup, and clarified compatibility with React versions.

Possibly related PRs

Suggested labels

📋 Scope : Docs

Suggested reviewers

  • wingkwong
  • jrgarciadev

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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 to yarn 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)
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8c8b70d and 8bdb5d9.

📒 Files selected for processing (1)
  • apps/docs/content/docs/guide/installation.mdx (1 hunks)

@clementvt
Copy link
Contributor Author

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 )
If you have any suggestions for improvement, please let me know.

@wingkwong wingkwong changed the title Update installation.mdx fix(docs): yarn global command in installation page Nov 8, 2024
@jrgarciadev
Copy link
Member

Thanks! @clementvt

@jrgarciadev jrgarciadev merged commit d4e40ba into nextui-org:main Nov 27, 2024
0 of 2 checks passed
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.

3 participants