nuxt-hub / core

Build full-stack applications with Nuxt on CloudFlare, with zero configuration.
https://hub.nuxt.com
Apache License 2.0
835 stars 39 forks source link

docs: use new `nuxi module add` command in installation #62

Closed shinGangan closed 3 months ago

shinGangan commented 3 months ago

📚 Description

I have been eagerly awaiting the modularization of @nuxthub/core and am very excited about the v0.4.0 release.

I think the nuxi module add command will make it easier to install and add modules to nuxt.config. So I would like to have a section for the Nuxi command to the docs.

🖐️ Design

Add a Use Nuxi(Nuxt CLI) section along with the Add to a Nuxt project section.

Reason

Users unfamiliar with Nuxi are more likely to refer to the Add to a Nuxt project section, while users familiar with Nuxi are more likely to use Nuxi. Considering that many non Nuxt native users will use (or start using) Nuxt in the future, I think it is acceptable to describe both in the current version.

As another repository trend, @danielroe has created a PR recommending the use of Nuxi in the Storybook module, Nuxt UI. Therefore, I see no problem with removing the Add to a Nuxt project section for the sake of uniformity.

shinGangan commented 3 months ago

Hi @Atinux , I would appreciate your comments when you have time. 🙏

If there is no problem with the policy I will create a PR on my end ( experimental commit ).

Atinux commented 3 months ago

I think we can just document to use the nuxi command @shinGangan

We still need to tell user to add wrangler as second step.

Happy for you to draft a PR?

shinGangan commented 3 months ago

OK, I'll create a PR 🙆