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: clarify nuxi start command usage #23215

Merged

Conversation

PetroSilenius
Copy link
Contributor

โ“ Type of change

  • ๐Ÿ“– Documentation (updates to the documentation, readme or JSdoc annotations)
  • ๐Ÿž Bug fix (a non-breaking change that fixes an issue)
  • ๐Ÿ‘Œ Enhancement (improving an existing functionality like performance)
  • โœจ 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

nuxi start command isn't easily understandable to be an alias for the preview command and might get misunderstood as the command to run the nuxt application in production. The difference between the two is fairly small but unnecessarily loading the .env file should be avoided.

npx nuxi start --help gives this info about the start command

> Usage: npx nuxi preview|start [--dotenv] [rootDir]

โ‹ฎ Launches nitro server for local testing after nuxi build.

Use npx nuxi [command] --help to see help for each command

Also linked the Deployment section of the docs so it's clear where to look for instructions on deploying your application after previewing it

๐Ÿ“ Checklist

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

@stackblitz
Copy link

stackblitz bot commented Sep 14, 2023

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@nuxt-studio
Copy link

nuxt-studio bot commented Sep 14, 2023

โœ… Live Preview ready!

Name Edit Preview Latest Commit
Nuxt Docs Edit on Studio โ†—๏ธŽ View Live Preview 10c5153

@danielroe danielroe merged commit 2e0e237 into nuxt:main Sep 14, 2023
3 checks passed
@github-actions github-actions bot mentioned this pull request Sep 14, 2023
@PetroSilenius
Copy link
Contributor Author

That was super fast, thanks! ๐ŸŽ๏ธ

@PetroSilenius PetroSilenius deleted the docs/clarify-nuxi-start-command-usage branch September 14, 2023 13:03
Copy link
Member

danielroe commented Sep 14, 2023

Thank you โค๏ธ

@github-actions github-actions bot mentioned this pull request Sep 26, 2023
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.

None yet

3 participants