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
docs(guide): add an explanation for the installation guide #2769
docs(guide): add an explanation for the installation guide #2769
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git βοΈ
|
WalkthroughThe update enhances the installation guide for NextUI by including detailed steps for setting up dependencies, starting a local server, and utilizing the CLI to integrate individual components, thereby streamlining the development process. Changes
Possibly related issues
Recent Review DetailsConfiguration used: .coderabbit.yaml Files selected for processing (2)
Additional Context UsedLanguageTool (78)
Additional comments not posted (2)
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
@Nozomi-Hijikata is attempting to deploy a commit to the NextUI Inc Team on Vercel. A member of the Team first needs to authorize it. |
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.
there should be a guideline added in CLI output as well.
@wingkwong |
++ @winchesHe |
@winchesHe @wingkwong |
@Nozomi-Hijikata I was putting this on hold because we want the CLI output to be same. Also this needs to be merged after the new CLI output getting merged first. @winchesHe any supplement? |
Then, do you mean that the version of CLI should be included in the output example?
Okay, I will wait for the new CLI output to be merged first. |
@wingkwong nextui-org/nextui-cli#36 CLI have been merged i think it also can merge, after that i will working multiple pacakge manager support |
4034042
into
nextui-org:docs/for-next-release
* feat(docs): add example how to set locale (#2867) * docs(guide): add an explanation for the installation guide (#2769) * docs(guide): add an explanation for the installation guide * docs(guide): add an explanation for the cli guide * docs(guide): add support for cli output * fix: change sort priority - cmdk (#2873) * docs: remove unsupported props in range calendar and date range picker (#2881) * chore(calendar): remove showMonthAndYearPickers from range calendar story * docs(date-range-picker): remove showMonthAndYearPickers info * docs(range-calendar): remove unsupported props * docs: refactor typing in form.ts (#2882) * chore(docs): supplement errorMessage behaviour in input (#2892) * refactor(docs): revise NextUI Provider structure * chore(docs): add updated tag --------- Co-authored-by: Nozomi-Hijikata <116155762+Nozomi-Hijikata@users.noreply.github.com> Co-authored-by: HaRuki <soccer_haruki15@me.com> Co-authored-by: Kaben <carnoxen@gmail.com>
* feat(docs): add example how to set locale (nextui-org#2867) * docs(guide): add an explanation for the installation guide (nextui-org#2769) * docs(guide): add an explanation for the installation guide * docs(guide): add an explanation for the cli guide * docs(guide): add support for cli output * fix: change sort priority - cmdk (nextui-org#2873) * docs: remove unsupported props in range calendar and date range picker (nextui-org#2881) * chore(calendar): remove showMonthAndYearPickers from range calendar story * docs(date-range-picker): remove showMonthAndYearPickers info * docs(range-calendar): remove unsupported props * docs: refactor typing in form.ts (nextui-org#2882) * chore(docs): supplement errorMessage behaviour in input (nextui-org#2892) * refactor(docs): revise NextUI Provider structure * chore(docs): add updated tag --------- Co-authored-by: Nozomi-Hijikata <116155762+Nozomi-Hijikata@users.noreply.github.com> Co-authored-by: HaRuki <soccer_haruki15@me.com> Co-authored-by: Kaben <carnoxen@gmail.com>
π Description
Add an explanation for the installation page
β³οΈ Current behavior (updates)
Currently, there is no explanation for users to install packages after initialization.
current version here
Therefore, it is possible that users may encounter such situation.
This is because the dependencies are not installed in the project directory.
After the installation of dependencies, the
next dev
command works correctly.π New behavior
Add an install process in the guide.
π£ Is this a breaking change (Yes/No):
No.
π Additional Information
Nothing special!
Summary by CodeRabbit