From 2afc1fe2264ae6fd51853dd53f26f2e08812323e Mon Sep 17 00:00:00 2001 From: Daniel Roe Date: Sun, 30 Jun 2024 11:11:16 +0100 Subject: [PATCH] docs: update `Nuxt 3` -> `Nuxt` or `Nuxt 3+` --- docs/1.getting-started/1.introduction.md | 1 - docs/1.getting-started/10.deployment.md | 4 ++-- docs/1.getting-started/12.upgrade.md | 10 ++++---- docs/1.getting-started/2.installation.md | 2 +- docs/1.getting-started/6.data-fetching.md | 2 +- docs/1.getting-started/8.error-handling.md | 2 +- docs/1.getting-started/9.layers.md | 2 +- .../2.guide/1.concepts/2.vuejs-development.md | 10 ++++---- docs/2.guide/1.concepts/3.rendering.md | 4 ++-- docs/2.guide/1.concepts/4.server-engine.md | 4 ++-- docs/2.guide/1.concepts/7.esm.md | 4 ++-- docs/2.guide/1.concepts/8.typescript.md | 6 ++--- docs/2.guide/2.directory-structure/1.pages.md | 2 +- .../2.directory-structure/3.app-config.md | 2 +- docs/3.api/2.composables/use-nuxt-app.md | 2 +- docs/3.api/4.commands/upgrade.md | 4 ++-- docs/3.api/5.kit/11.nitro.md | 2 +- docs/3.api/5.kit/7.pages.md | 2 +- docs/3.api/5.kit/8.layout.md | 2 +- docs/5.community/2.getting-help.md | 2 +- docs/5.community/3.reporting-bugs.md | 24 +++++++------------ docs/5.community/6.roadmap.md | 6 ++--- examples/README.md | 2 +- packages/schema/src/config/adhoc.ts | 2 +- playground/app.vue | 2 +- 25 files changed, 49 insertions(+), 56 deletions(-) diff --git a/docs/1.getting-started/1.introduction.md b/docs/1.getting-started/1.introduction.md index 47bfdb0bc4..d092c50579 100644 --- a/docs/1.getting-started/1.introduction.md +++ b/docs/1.getting-started/1.introduction.md @@ -76,7 +76,6 @@ Nuxt is composed of different [core packages](https://github.com/nuxt/nuxt/tree/ - Command line interface: [nuxi](https://github.com/nuxt/nuxt/tree/main/packages/nuxi) - Server engine: [nitro](https://github.com/unjs/nitro) - Development kit: [@nuxt/kit](https://github.com/nuxt/nuxt/tree/main/packages/kit) -- Nuxt 2 Bridge: [@nuxt/bridge](https://github.com/nuxt/bridge) We recommend reading each concept to have a full vision of Nuxt capabilities and the scope of each package. diff --git a/docs/1.getting-started/10.deployment.md b/docs/1.getting-started/10.deployment.md index 582a24d14a..239b73e4e2 100644 --- a/docs/1.getting-started/10.deployment.md +++ b/docs/1.getting-started/10.deployment.md @@ -85,13 +85,13 @@ export default defineNuxtConfig({ ## Hosting Providers -Nuxt 3 can be deployed to several cloud providers with a minimal amount of configuration: +Nuxt can be deployed to several cloud providers with a minimal amount of configuration: :read-more{to="/deploy"} ## Presets -In addition to Node.js servers and static hosting services, a Nuxt 3 project can be deployed with several well-tested presets and minimal amount of configuration. +In addition to Node.js servers and static hosting services, a Nuxt project can be deployed with several well-tested presets and minimal amount of configuration. You can explicitly set the desired preset in the [`nuxt.config.ts`](/docs/guide/directory-structure/nuxt-config) file: diff --git a/docs/1.getting-started/12.upgrade.md b/docs/1.getting-started/12.upgrade.md index ed89453ede..4e07ea4c44 100644 --- a/docs/1.getting-started/12.upgrade.md +++ b/docs/1.getting-started/12.upgrade.md @@ -502,11 +502,11 @@ These options have been set to their current values for some time and we do not * `respectNoSSRHeader`is implementable in user-land with [server middleware](https://github.com/nuxt/nuxt/blob/c660b39447f0d5b8790c0826092638d321cd6821/packages/nuxt/src/core/runtime/nitro/no-ssr.ts#L8-L9) -## Nuxt 2 vs Nuxt 3 +## Nuxt 2 vs Nuxt 3+ In the table below, there is a quick comparison between 3 versions of Nuxt: -Feature / Version | Nuxt 2 | Nuxt Bridge | Nuxt 3 +Feature / Version | Nuxt 2 | Nuxt Bridge | Nuxt 3+ -------------------------|-----------------|------------------|--------- Vue | 2 | 2 | 3 Stability | 😊 Stable | 😊 Stable | 😊 Stable @@ -524,9 +524,9 @@ Vite | ⚠️ Partial | 🚧 Partial | βœ… Nuxi CLI | ❌ Old | βœ… nuxi | βœ… nuxi Static sites | βœ… | βœ… | βœ… -## Nuxt 2 to Nuxt 3 +## Nuxt 2 to Nuxt 3+ -The migration guide provides a step-by-step comparison of Nuxt 2 features to Nuxt 3 features and guidance to adapt your current application. +The migration guide provides a step-by-step comparison of Nuxt 2 features to Nuxt 3+ features and guidance to adapt your current application. ::read-more{to="/docs/migration/overview"} Check out the **guide to migrating from Nuxt 2 to Nuxt 3**. @@ -534,7 +534,7 @@ Check out the **guide to migrating from Nuxt 2 to Nuxt 3**. ## Nuxt 2 to Nuxt Bridge -If you prefer to progressively migrate your Nuxt 2 application to Nuxt 3, you can use Nuxt Bridge. Nuxt Bridge is a compatibility layer that allows you to use Nuxt 3 features in Nuxt 2 with an opt-in mechanism. +If you prefer to progressively migrate your Nuxt 2 application to Nuxt 3, you can use Nuxt Bridge. Nuxt Bridge is a compatibility layer that allows you to use Nuxt 3+ features in Nuxt 2 with an opt-in mechanism. ::read-more{to="/docs/bridge/overview"} **Migrate from Nuxt 2 to Nuxt Bridge** diff --git a/docs/1.getting-started/2.installation.md b/docs/1.getting-started/2.installation.md index 79c9ca8ed7..32e8eb7f29 100644 --- a/docs/1.getting-started/2.installation.md +++ b/docs/1.getting-started/2.installation.md @@ -100,6 +100,6 @@ Well done! A browser window should automatically open for console.log(document.cookie)) ## Options API support -Nuxt 3 provides a way to perform `asyncData` fetching within the Options API. You must wrap your component definition within `defineNuxtComponent` for this to work. +Nuxt provides a way to perform `asyncData` fetching within the Options API. You must wrap your component definition within `defineNuxtComponent` for this to work. ```vue ``` -The goal of Nuxt 3 is to provide a great developer experience around the Composition API. +The goal of Nuxt is to provide a great developer experience around the Composition API. -- Use auto-imported [Reactivity functions](https://vuejs.org/api/reactivity-core.html) from Vue and Nuxt 3 [built-in composables](/docs/api/composables/use-async-data). +- Use auto-imported [Reactivity functions](https://vuejs.org/api/reactivity-core.html) from Vue and Nuxt [built-in composables](/docs/api/composables/use-async-data). - Write your own auto-imported reusable functions in the [`composables/` directory](/docs/guide/directory-structure/composables). ### TypeScript Support -Both Vue 3 and Nuxt 3 are written in TypeScript. A fully typed codebase prevents mistakes and documents APIs usage. This doesn’t mean that you have to write your application in TypeScript to take advantage of it. With Nuxt 3, you can opt-in by renaming your file from `.js` to `.ts` , or add `