Skip to content

Commit

Permalink
docs: fix paths to migration guides (nuxt#9071)
Browse files Browse the repository at this point in the history
  • Loading branch information
clemcode authored Nov 16, 2022
1 parent cd2ad71 commit 67ee085
Show file tree
Hide file tree
Showing 11 changed files with 15 additions and 23 deletions.
4 changes: 2 additions & 2 deletions docs/content/1.docs/1.getting-started/11.upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@ Static sites | ✅ | ✅ | ✅
The migration guide provides a step-by-step comparison of Nuxt 2 features to Nuxt 3 features and guidance to adapt your current application.

::alert{type=info icon=👉}
[**Migrate from From Nuxt 2 to Nuxt 3**](/migration/overview)
[**Migrate from From Nuxt 2 to Nuxt 3**](/docs/migration/overview)
::

## 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.

::alert{type=info icon=👉}
[**Migrate from Nuxt 2 to Nuxt Bridge**](/bridge/overview)
[**Migrate from Nuxt 2 to Nuxt Bridge**](/docs/bridge/overview)
::

## Upgrading Nuxt 3
Expand Down
6 changes: 3 additions & 3 deletions docs/content/1.docs/6.bridge/1.overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ This also means that when you need to access public runtime config, it's behind

## Migrate Composition API

If you were using `@vue/composition-api` or `@nuxtjs/composition-api`, please read the [composition api migration guide](/bridge/bridge-composition-api).
If you were using `@vue/composition-api` or `@nuxtjs/composition-api`, please read the [composition api migration guide](/docs/bridge/bridge-composition-api).

### Migrate from CommonJS to ESM

Expand All @@ -188,8 +188,8 @@ Nuxt 3 natively supports TypeScript and ECMAScript Modules. Please check [Native
- Remove `@nuxt/typescript-build`: Bridge enables same functionality
- Remove `@nuxt/typescript-runtime` and `nuxt-ts`: Nuxt 2 has built-in runtime support
- Remove `@nuxt/nitro`: Bridge injects same functionality
- Remove `@vue/composition-api` from your dependencies ([migration guide](/bridge/bridge-composition-api)).
- Remove `@nuxtjs/composition-api` from your dependencies (and from your modules in `nuxt.config`) ([migration guide](/bridge/bridge-composition-api)).
- Remove `@vue/composition-api` from your dependencies ([migration guide](/docs/bridge/bridge-composition-api)).
- Remove `@nuxtjs/composition-api` from your dependencies (and from your modules in `nuxt.config`) ([migration guide](/docs/bridge/bridge-composition-api)).

## Exclude Built Nitro Folder From Git

Expand Down
2 changes: 1 addition & 1 deletion docs/content/1.docs/6.bridge/2.bridge-composition-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ export default <Plugin> function (ctx, inject) {}
```

::alert
You may wish to [migrate your plugins to Nuxt 3-style plugins](/bridge#new-plugins-format-optional) as a next (optional) step.
You may wish to [migrate your plugins to Nuxt 3-style plugins](/docs/bridge#new-plugins-format-optional) as a next (optional) step.
::

### `onGlobalSetup`
Expand Down
4 changes: 0 additions & 4 deletions docs/content/1.docs/6.bridge/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/content/1.docs/7.migration/1.overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ Some of these significant changes include:
1. Moving from a runtime Nuxt dependency to a minimal, standalone server compiled with nitropack.

::alert{type=info}
If you need to remain on Nuxt 2, but want to benefit from Nuxt 3 features in Nuxt 2, you can alternatively check out [how to get started with Bridge](/bridge/overview).
If you need to remain on Nuxt 2, but want to benefit from Nuxt 3 features in Nuxt 2, you can alternatively check out [how to get started with Bridge](/docs/bridge/overview).
::
2 changes: 1 addition & 1 deletion docs/content/1.docs/7.migration/2.configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Nuxt and Nuxt Modules are now build-time-only.
2. Check for Nuxt 3 compatibility of modules.

::alert
If you are a module author, you can check out [more information about module compatibility](/migration/module-authors) and [our module author guide](/docs/guide/going-further/modules).
If you are a module author, you can check out [more information about module compatibility](/docs/migration/module-authors) and [our module author guide](/docs/guide/going-further/modules).
::

## TypeScript
Expand Down
2 changes: 1 addition & 1 deletion docs/content/1.docs/7.migration/20.module-authors.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ When Nuxt 3 users add your module, you will not have access to the module contai

Migrating to `@nuxt/bridge` is the first and most important step for supporting Nuxt 3.

If you have a fixture or example in your module, add `@nuxt/bridge` package to its config (see [example](/bridge#update-nuxtconfig))
If you have a fixture or example in your module, add `@nuxt/bridge` package to its config (see [example](/docs/bridge#update-nuxtconfig))

### Migrate from CommonJS to ESM

Expand Down
2 changes: 1 addition & 1 deletion docs/content/1.docs/7.migration/3.auto-imports.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Nuxt 3 adopts a minimal friction approach, meaning wherever possible components and composables are auto-imported.

::alert{type=info}
In the rest of the migration documentation, you will notice that key Nuxt and Vue utilities do not have explicit imports. This is not a typo; Nuxt will automatically import them for you, and you should get full type hinting if you have followed [the instructions](/migration/configuration#typescript) to use Nuxt's TypeScript support.
In the rest of the migration documentation, you will notice that key Nuxt and Vue utilities do not have explicit imports. This is not a typo; Nuxt will automatically import them for you, and you should get full type hinting if you have followed [the instructions](/docs/migration/configuration#typescript) to use Nuxt's TypeScript support.
::

[Read more about auto imports](/docs/guide/concepts/auto-imports)
Expand Down
2 changes: 1 addition & 1 deletion docs/content/1.docs/7.migration/6.pages-and-layouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ In Nuxt 2, you will have defined any nested routes (with parent and child compon

If you were passing a custom page key or keep-alive props to `<Nuxt>`, you will now use `definePageMeta` to set these options.

See [more about migrating Nuxt component hooks](/migration/component-options).
See [more about migrating Nuxt component hooks](/docs/migration/component-options).

### Page and Layout Transitions

Expand Down
8 changes: 4 additions & 4 deletions docs/content/1.docs/7.migration/7.component-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Despite the names, `useFetch` is not a direct replacement of the `fetch()` hook.

## `head`

See [meta tag migration](/migration/meta).
See [meta tag migration](/docs/migration/meta).

## `key`

Expand Down Expand Up @@ -92,23 +92,23 @@ You can now define a key within the `definePageMeta` compiler macro.

## `layout`

See [layout migration](/migration/pages-and-layouts).
See [layout migration](/docs/migration/pages-and-layouts).

## `loading`

This feature is not yet supported in Nuxt 3.

## `middleware`

See [middleware migration](/migration/plugins-and-middleware).
See [middleware migration](/docs/migration/plugins-and-middleware).

## `scrollToTop`

This feature is not yet supported in Nuxt 3. If you want to overwrite the default scroll behavior of `vue-router`, you can do so in `~/app/router.options.ts` (see [docs](/docs/guide/directory-structure/pages/#router-options)) for more info.

## `transition`

See [layout migration](/migration/pages-and-layouts).
See [layout migration](/docs/migration/pages-and-layouts).

## `validate`

Expand Down
4 changes: 0 additions & 4 deletions docs/content/1.docs/7.migration/index.md

This file was deleted.

0 comments on commit 67ee085

Please sign in to comment.