docs: Add v5 upgrade notes

i18next · Aug 22, 2024 · e308d82 · e308d82
1 parent 6ed4638
commit e308d82
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -14,7 +14,7 @@ export default defineConfig({
         link: '/guide/started',
       },
       {
-        text: 'v2.x - 4.x (Vue 3)',
+        text: 'v2.x - 5.x (Vue 3)',
         items: [
           { text: 'v1.x (Vue 2)', link: 'https://i18next.github.io/i18next-vue/vue-2/introduction' }
         ]

diff --git a/docs/migration-v4.md b/docs/migration-v4.md
@@ -16,3 +16,13 @@ Then iteratively migrate all its uses to `useTranslation()` with its [new parame
 ## New/changed functionality
 
 No new functionality. This is a cleanup-only release.
+
+# Migration to `i18next-vue` v5.x
+
+(Re-phrasing the [Vue Router changelog](https://github.com/vuejs/router/blob/main/packages/router/CHANGELOG.md#441-2024-07-31) for an analogous change):
+
+> This release replaces `declare module '@vue/runtime-core'` with `declare module 'vue'` [like it's supposed to be](https://vuejs.org/guide/typescript/options-api.html#augmenting-global-properties). If you (or packages you use) are also augmenting `@vue/runtime-core`, you will likely have to change it to `vue`. It is also recommended to use an up-to-date TypeScript version (>=5.4) and `"moduleResolution": "Bundler"` in your `tsconfig.json`.
+
+## New/changed functionality
+
+No other changes/migration necessary.