diff --git a/docs/content/1.getting-started/1.index.md b/docs/content/1.getting-started/1.index.md index 7dc52451..f8e96506 100644 --- a/docs/content/1.getting-started/1.index.md +++ b/docs/content/1.getting-started/1.index.md @@ -12,7 +12,7 @@ We're thrilled to introduce this major update to our UI library, bringing signif We've transitioned from [Headless UI](https://headlessui.com/) to [Radix Vue](https://www.radix-vue.com/) as our core component foundation. This shift brings several key advantages: -- **Extensive Component Library**: With 40+ primitives, Radix Vue significantly expands our component offerings. +- **Extensive Component Library**: With 55+ primitives, Radix Vue significantly expands our component offerings. - **Active Development**: Radix Vue's growing popularity ensures ongoing improvements and updates. - **Enhanced Accessibility**: Built-in accessibility features align with our commitment to inclusive design. - **Vue 3 Optimization**: Seamless integration with Vue 3 and the Composition API. @@ -47,29 +47,34 @@ We've adopted [Tailwind Variants](https://github.com/nextui-org/tailwind-variant This integration streamlines development, enhances flexibility, improves maintainability, and boosts overall performance in Nuxt UI v3. -## Migration and Compatibility +## Migration We want to be transparent: migrating from Nuxt UI v2 to v3 will require significant effort. While we've maintained core concepts and components, Nuxt UI v3 has been rebuilt from the ground up, resulting in a new library with enhanced capabilities. -For detailed migration instructions and compatibility information, please refer to our [migration guide](/getting-started/migration). +Key points to consider: +- A comprehensive migration guide will be available in the coming weeks. +- Review the new documentation and components carefully before attempting to upgrade. +- If you encounter any issues, please report them on our [GitHub repository](https://github.com/nuxt/ui/issues). ## Frequently Asked Questions ::accordion - ::accordion-item{label="Is Nuxt UI v3 compatible with my existing Nuxt UI v2 project?"} - While we've aimed to maintain compatibility where possible, the transition to Radix Vue and other major changes necessitate some adjustments. Consult our [migration guide](/getting-started/migration) for detailed upgrade instructions. + ::accordion-item{label="What are the main compatibility challenges when upgrading to Nuxt UI v3?"} + The transition to Radix Vue and other significant changes limit direct compatibility between v2 and v3. Major differences include: + + - New component structure and APIs + - Changes in theming and customization approaches + - Updated TypeScript definitions and prop types + + We recommend a careful, incremental approach to upgrading, starting with thorough testing in a development environment. :: - ::accordion-item{label="What are the main differences between Nuxt UI v3 and v2?"} - Key differences include the switch to Radix Vue, improved accessibility, enhanced composability, Tailwind CSS v4 integration, and better TypeScript support. These changes result in more flexible and powerful components with improved performance and developer experience. - :: - - ::accordion-item{label="Will Nuxt UI v3 work with other CSS frameworks besides Tailwind CSS?"} - Currently, Nuxt UI v3 is designed to work exclusively with Tailwind CSS. While there have been community requests for UnoCSS support, it's important to note that implementing UnoCSS would require significant changes to the theme structure. This is because UnoCSS uses different class naming conventions and utility classes compared to Tailwind CSS (see [UnoCSS documentation](https://unocss.dev/) for details). As a result, we don't have immediate plans to add UnoCSS support in v3, as it would involve a substantial rework of the component theming system. + ::accordion-item{label="Will Nuxt UI v3 work with other CSS frameworks like UnoCSS?"} + Nuxt UI v3 is currently designed to work exclusively with Tailwind CSS. While there's interest in UnoCSS support, implementing it would require significant changes to the theme structure due to differences in class naming conventions. As a result, we don't have plans to add UnoCSS support in v3. :: ::accordion-item{label="Is Nuxt UI v3 compatible with standalone Vue projects?"} - We're actively working on adding Vue support in the near future. For now, Nuxt UI v3 is only available for Nuxt projects. Track progress on Vue compatibility [here](https://github.com/nuxt/ui/issues/2129). + We're planning to add Vue support in the near future. For now, Nuxt UI v3 is only available for Nuxt projects. Track progress on Vue compatibility [in this issue](https://github.com/nuxt/ui/issues/2129). :: ::accordion-item{label="Is this version stable and suitable for production use?"}