docs: add instructions about moduleResolution: Bundler

See #323

Author: posva

CHANGELOG.md

@@ -149,7 +149,7 @@ For people using the file-based routing, you now need to add `unplugin-vue-route
   - Data Loaders now return an `isLoading` property instead
     of `pending`. This aligns better with the wording of Data Loaders being
     in a loading state rather than pending, which can have more meanings.
-  - You know need to add `unplugin-vue-router/client` to the `types` property of your tsconfig. See [setup](https://uvr.esm.is/introduction.html#setup) for an example.
+  - You know need to add `unplugin-vue-router/client` to the `types` property of your tsconfig. See [setup](https://uvr.esm.is/introduction.html#setup) for an example. This file contains the augmentation of the `vue-router/auto` module that was previously in `typed-router.d.ts`. You also need to set the `modeResolution` to `Bundler` in your `tsconfig.json`.
 
   - the existing `defineLoader` is being replaced by a
     basic loader without cache. The version with cache will be implemented

docs/introduction.md

@@ -76,21 +76,25 @@ build({
 
 ## Setup
 
-After adding this plugin, **start the dev server** (usually `npm run dev`) **to generate the first version of the types** at `typed-router.d.ts` which should be added to your `tsconfig.json` along with `unplugin-vue-router/client` to `types`. This is what it should look like:
+After adding this plugin, **start the dev server** (usually `npm run dev`) **to generate the first version of the types** at `typed-router.d.ts` which should be added to your `tsconfig.json` along with `unplugin-vue-router/client` to `types` and `"moduleResolution": "Bundler"`. This is what it should look like:
 
 ::: code-group
 
-```json{4,8} [tsconfig.json]
+```json{4,8,11} [tsconfig.json]
 {
   "include": [
     // other files...
     "./typed-router.d.ts"
   ],
-  "types": [
-    // other types...
-    "unplugin-vue-router/client"
-  ]
-  // other options...
+  "compilerOptions": {
+    // ...
+    "moduleResolution": "Bundler",
+    "types": [
+      // other types...
+      "unplugin-vue-router/client"
+    ]
+    // other options...
+  }
 }
 ```