chore: update framework installations #4410
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThis pull request updates the documentation for NextUI integration across multiple frameworks (Next.js, Remix, and Vite). The changes focus on improving installation instructions, introducing a new CLI approach for project initialization, and providing comprehensive setup guidance. The documentation now includes commands for various package managers, clarifies component installation processes, and offers more detailed configuration instructions for different project structures. Changes
Possibly related PRs
Suggested Reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (1)
🧰 Additional context used🪛 LanguageToolapps/docs/content/docs/frameworks/remix.mdx[style] ~55-~55: To strengthen your wording, consider replacing the phrasal verb “leave out”. (OMIT_EXCLUDE) apps/docs/content/docs/frameworks/vite.mdx[uncategorized] ~68-~68: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA) [style] ~75-~75: To strengthen your wording, consider replacing the phrasal verb “leave out”. (OMIT_EXCLUDE) 🔇 Additional comments (1)apps/docs/content/docs/frameworks/remix.mdx (1)
The template URL references a repository that was previously marked as TODO. Please ensure the repository is public and accessible before merging this PR. 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
|
|
|
||
| <PackageManagers | ||
| commands={{ | ||
| npm: 'npx create-remix@latest --template https://github.com/nextui-org/remix-template', |
There was a problem hiding this comment.
TODO:
- Making the remix template public.
macci001
force-pushed
the
macci001/eng-1686
branch
from
8595938 to
ca36fd5
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
apps/docs/content/docs/frameworks/nextjs.mdx (1)
Line range hint
391-391: Enhance visibility of import best practicesThe crucial information about importing from individual packages (e.g.,
@nextui-org/button) rather than the main package is currently a note at the end of a section.Consider moving this information to a more prominent position, such as right after the first component import example, and emphasize it with a warning blockquote:
+<Blockquote color="warning"> +**Important**: Import components from their individual packages (e.g., `@nextui-org/button`) instead of `@nextui-org/react` for better tree-shaking and smaller bundle sizes. +</Blockquote>
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
apps/docs/content/docs/frameworks/nextjs.mdx(2 hunks)apps/docs/content/docs/frameworks/remix.mdx(1 hunks)apps/docs/content/docs/frameworks/vite.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
apps/docs/content/docs/frameworks/vite.mdx
[uncategorized] ~68-~68: Possible missing comma found.
Context: ...Block bash nextui add button input ``` Or you can add the main library `@nextui-o...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~75-~75: To strengthen your wording, consider replacing the phrasal verb “leave out”.
Context: ...Block bash nextui add --all ``` If you leave out the component name, the CLI will prompt...
(OMIT_EXCLUDE)
apps/docs/content/docs/frameworks/remix.mdx
[style] ~55-~55: To strengthen your wording, consider replacing the phrasal verb “leave out”.
Context: ...Block bash nextui add --all ``` If you leave out the component name, the CLI will prompt...
(OMIT_EXCLUDE)
🔇 Additional comments (1)
apps/docs/content/docs/frameworks/remix.mdx (1)
26-29:
Ensure the Remix template repository is publicly accessible
The template URL is being referenced in the installation commands, but there's a pending TODO about making the template public. This needs to be addressed before release to prevent a broken experience for users.
macci001
force-pushed
the
macci001/eng-1686
branch
from
ca36fd5 to
342ef90
Compare
macci001
force-pushed
the
macci001/eng-1686
branch
from
342ef90 to
6d781c6
Compare
Closes ENG-1686
📝 Description
Pr updates the docs for framework installations of Next, Remix and Vite.
⛳️ Current behavior (updates)
🚀 New behavior
💣 Is this a breaking change (Yes/No):
📝 Additional Information
Summary by CodeRabbit
<PackageManagers>component for easier project initialization across various package managers.