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

docs: use new nuxi module add command in installation #1606

Merged
merged 9 commits into from
Apr 10, 2024

Conversation

danielroe
Copy link
Member

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

This updates the documentation to use the nuxi module add command which should simplify docs a bit and also improve user experience as there's no need to add to nuxt.config manually.

It's documented here.

I may have missed a few spots in the documentation as I'm doing this across the modules ecosystem assisted by the power of regular expressions ✨, so I'd appreciate a review πŸ™

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

docs/pages/index.vue Outdated Show resolved Hide resolved
@shinGangan
Copy link
Contributor

shinGangan commented Apr 4, 2024

Hi @danielroe , thanks for this PR.
I was discussing the same issue here -> #1554

Nuxt has an excellent starter called Nuxt Starter along with Nuxt CLI.
I think this section should write nuxi init -t ui along with nuxi module add ui.

I would like to give an option to those who are new to Nuxt UI (I often use nuxi init -t ui).

I would like to hear @danielroe 's opinion on this.

(I was thinking of adding a section to this document.
So if I am adding nuxi init -t ui, we might want to separate the PRs. πŸ€”)

@danielroe
Copy link
Member Author

Yes, I think it's a good idea to separate the PRs (or you could open a PR to my branch and we could combine it if you prefer). Apologies for shadowing your idea - it was a good one. πŸ™

pnpm add @nuxt/ui
# bun
bun add @nuxt/ui
npx nuxi@latest module add ui
```

Then, register the module in your `nuxt.config.ts`:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@danielroe I assume we can remove this section about adding it to nuxt.config.ts, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we can. Unless you want to mention that you can configure it there.

@shinGangan
Copy link
Contributor

Yes, I think it's a good idea to separate the PRs (or you could open a PR to my branch and we could combine it if you prefer). Apologies for shadowing your idea - it was a good one. πŸ™

@danielroe , thanks for the response.

Then I woud like to open a PR on my end later.
(That way this PR will be less complicated and easier to review).

@benjamincanac benjamincanac merged commit f08471c into dev Apr 10, 2024
2 checks passed
@benjamincanac benjamincanac deleted the module-installation branch April 10, 2024 15:52
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