Skip to content

Conversation

@cheezone
Copy link

πŸ”— 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 PR updates the README.md documentation to clearly distinguish between Nuxt 3 and Nuxt 4 telemetry configuration syntax.

Changes made:

  • Added separate sections for Nuxt 3 and Nuxt 4 configuration examples
  • Updated the "Opting-out" section to show both configuration formats:
    • Nuxt 3: telemetry: false / telemetry: true
    • Nuxt 4: telemetry: { enabled: false } / telemetry: { enabled: true }
  • Updated the "Skip Prompt" section with the same distinction
  • Added a "Universal" section for methods that work in both versions (environment variables and CLI commands)

Why this change is required:
Nuxt 4 introduced a new telemetry configuration format using an object with an enabled property, while Nuxt 3 used a simple boolean. This change helps users understand the correct syntax for their specific Nuxt version and prevents configuration errors.

Problem solved:
Users were previously confused about the correct telemetry configuration syntax, especially when migrating from Nuxt 3 to Nuxt 4 or when following documentation examples that didn't specify the version.

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.

1 participant