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: update example options in readme to mention using old cli #835

Merged

Conversation

deleteme
Copy link
Contributor

πŸ”— Linked issue

#834

❓ 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 like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

This improves the readme to mention additional steps needed in order to use the nitro: false option.

By including usage notes in the nitro sample config provided in the readme, this may help people avoid a non-obvious gotcha.

Had these notes been next to the sample Bridge config options, I wouldn't have thought that dev server was broken.

Follows #808

πŸ“ Checklist

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

By including usage notes in the `nitro` sample config provided in the readme,
this may help people avoid a non-obvious gotcha.

nuxt#834
@deleteme deleteme changed the title Update example config options in readme for Nitro gotcha docs: Update example config options in readme for Nitro gotcha Jun 26, 2023
@danielroe danielroe changed the title docs: Update example config options in readme for Nitro gotcha docs: update example options in readme to mention using old cli Jun 26, 2023
@danielroe danielroe merged commit 8fe2fbd into nuxt:main Jun 26, 2023
@danielroe danielroe mentioned this pull request Sep 14, 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.

2 participants