Skip to content

docs: add import instructions when auto-imports are disabled#840

Merged
danielroe merged 3 commits intonuxt:mainfrom
deleteme:update-imports-option-description-in-readme
Jul 17, 2023
Merged

docs: add import instructions when auto-imports are disabled#840
danielroe merged 3 commits intonuxt:mainfrom
deleteme:update-imports-option-description-in-readme

Conversation

@deleteme
Copy link
Copy Markdown
Contributor

🔗 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 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 modifies the example Bridge config in the readme to include a line of usage instructions for the imports option.

This imports option might be used by people who want to preserve explicit import statements when upgrading to Nuxt Bridge.

Providing a convenient example of where the Nuxt composables would be imported from (#app), this might help avoid incorrectly assuming that they're available from the @nuxt/bridge package or the #imports alias.

📝 Checklist

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

Comment thread README.md Outdated
@danielroe danielroe changed the title docs: Add usage instructions to imports option in readme docs: add import instructions when auto-imports are disabled (#840) Jul 17, 2023
@danielroe danielroe changed the title docs: add import instructions when auto-imports are disabled (#840) docs: add import instructions when auto-imports are disabled Jul 17, 2023
@danielroe danielroe merged commit c06688b into nuxt:main Jul 17, 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.

3 participants