docs(installation): updated the yarn installation command

[AzpektDev]

Closes #

📝 Description

There is no -g flag in yarn. global is a command which must immediately follow yarn.

Source: https://classic.yarnpkg.com/lang/en/docs/cli/global/

⛳️ Current behavior (updates)

When attempting to use yarn to install nextui-cli using the command provided in docs, yarn will return an error.

🚀 New behavior

Updated the command in docs based on https://classic.yarnpkg.com/lang/en/docs/cli/global/

💣 Is this a breaking change (Yes/No):

No

📝 Additional Information

Summary by CodeRabbit

• Documentation
  • Updated installation instructions for NextUI, clarifying the Yarn command.
  • Refined structure for automatic and manual installation processes.
  • Expanded manual installation section with detailed steps for global and individual installations.
  • Updated Tailwind CSS setup instructions for better clarity.

[changeset-bot]

⚠️ No Changeset found

Latest commit: c38a0c3

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

[vercel]

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

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

The changes in this pull request focus on updating the installation instructions for NextUI. Key modifications include a clarification of the Yarn installation command, restructuring the installation guide for better clarity, and expanding the manual installation section. The updates also include revisions to the Tailwind CSS setup instructions and reiteration of the use of pnpm for dependency management. Overall, these changes aim to enhance the usability and clarity of the installation documentation.

Changes

File Path	Change Summary
apps/docs/content/docs/guide/installation.mdx	Updated Yarn installation command, refined structure of installation instructions, expanded manual installation details, and revised Tailwind CSS setup instructions.

Possibly related PRs

• docs: installation update init description #3201: This PR updates the installation documentation, including modifications to the installation commands, which directly relates to the changes made in the main PR regarding the installation instructions for NextUI.
• fix(docs): added missing package manager tab #3631: This PR enhances the installation documentation by introducing a <PackageManagers> component, which aligns with the main PR's focus on improving the clarity of installation commands.
• fix(docs): added missing package manager tabs in docs #3650: This PR also introduces a <PackageManagers> component for the installation instructions, similar to the changes in the main PR, enhancing the usability of the documentation.
• refactor(docs): adding package manager options #3731: This PR adds a <PackageManagers> component and restructures the installation guide, which is directly related to the changes made in the main PR regarding installation instructions.

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

apps/docs/content/docs/guide/installation.mdx (1)

Line range hint 214-234: Fix line highlighting in Tailwind CSS configuration example.

The line highlighting {9,14-15} in the code block doesn't accurately reflect the important lines in the configuration example. Please update the line numbers to match the actual important lines in the code block.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 34bb098 and c38a0c3.

📒 Files selected for processing (1)

• apps/docs/content/docs/guide/installation.mdx (1 hunks)

🔇 Additional comments (3)

apps/docs/content/docs/guide/installation.mdx (3)

29-29: LGTM! Correct Yarn global installation command.

The updated command yarn global add nextui-cli follows the official Yarn documentation and fixes the installation error users were encountering.

---

Line range hint 1-24: Well-structured documentation with clear requirements and sections.

The documentation is logically organized with clear prerequisites and installation options. The separation between automatic and manual installation methods helps users choose the most appropriate approach for their needs.

---

Line range hint 1-424: Documentation changes align perfectly with PR objectives.

The update successfully addresses the yarn global installation command issue while maintaining the overall quality and accuracy of the installation documentation.