From be99c17c2901b9c2a6cc5c374dca851b3598a462 Mon Sep 17 00:00:00 2001
From: Krutie Patel <krutie.patel@gmail.com>
Date: Mon, 4 Jul 2022 00:51:43 +1000
Subject: [PATCH 1/6] docs: update navigateTo utils API page

---
 docs/content/3.api/3.utils/navigate-to.md | 67 ++++++++++++++++++++++-
 1 file changed, 64 insertions(+), 3 deletions(-)

diff --git a/docs/content/3.api/3.utils/navigate-to.md b/docs/content/3.api/3.utils/navigate-to.md
index c65a8b8427c..8cba03703a3 100644
--- a/docs/content/3.api/3.utils/navigate-to.md
+++ b/docs/content/3.api/3.utils/navigate-to.md
@@ -1,7 +1,68 @@
 # `navigateTo`
 
-::ReadMore{link="/guide/features/routing"}
-::
+`navigateTo` is a route helper function that allows creating programmatic navigation for users to navigate within Nuxt application.
+
+`navigateTo` is available on both server side and client side. It can be used within plugins, middleware or can be called directly to perform page navigation.
+
+> While using `navigateTo`, make sure to use `await` or chain its result by returning from functions.
+
+## Required parameter
+
+`navigateTo` takes route as a required parameter that can be a plain string or a route object.
+
+- **route:** type: string | Route
+
+### Example: Vue component
+
+```js
+<script setup>
+    function navigate(){
+        // string
+        return navigateTo('/search')
+
+        // route object
+        return navigateTo({ path: '/search' })
+        
+        // route object with query parameters
+        return navigateTo({
+            path: '/search',
+            query: {
+                name: name.value,
+                type: type.value
+            }
+        })
+    }
+</script>
+```
+
+## Optional parameters
 
-::NeedContribution
+- **redirectCode:** type: number
+
+`navigateTo` redirects to the given path and sets the redirect code to `302` by default when the redirect takes place on the server side. 
+
+This default behaviour can be modified by providing different `redirectCode` as an optional parameter.
+
+### Example: Route middleware
+
+```js
+export default defineNuxtRouteMiddleware((to, from) => {
+  // set the redirect code to 301 Moved Permanently
+  return navigateTo('/search', { redirectCode: 301 })
+})
+```
+
+- **replace:** type: boolean
+
+By default, `navigateTo` pushes the given route into Vue router instance on.
+
+This behaviour can be changed by setting `replace` to `true`, to indicate that given route should be replaced.
+
+```js
+<script setup>
+    await navigateTo('/', { replace: true })
+</script>
+```
+
+::ReadMore{link="/guide/features/routing"}
 ::

From 85de469621ec57c45daf13c5556988a3b8aac4ac Mon Sep 17 00:00:00 2001
From: Krutie Patel <krutie.patel@gmail.com>
Date: Mon, 4 Jul 2022 09:11:26 +1000
Subject: [PATCH 2/6] docs: remove function from the example

---
 docs/content/3.api/3.utils/navigate-to.md | 32 +++++++++++------------
 1 file changed, 15 insertions(+), 17 deletions(-)

diff --git a/docs/content/3.api/3.utils/navigate-to.md b/docs/content/3.api/3.utils/navigate-to.md
index 8cba03703a3..c9e6f684115 100644
--- a/docs/content/3.api/3.utils/navigate-to.md
+++ b/docs/content/3.api/3.utils/navigate-to.md
@@ -15,23 +15,21 @@
 ### Example: Vue component
 
 ```js
-<script setup>
-    function navigate(){
-        // string
-        return navigateTo('/search')
-
-        // route object
-        return navigateTo({ path: '/search' })
-        
-        // route object with query parameters
-        return navigateTo({
-            path: '/search',
-            query: {
-                name: name.value,
-                type: type.value
-            }
-        })
-    }
+<script setup>    
+    // string
+    return navigateTo('/search')
+
+    // route object
+    return navigateTo({ path: '/search' })
+    
+    // route object with query parameters
+    return navigateTo({
+        path: '/search',
+        query: {
+            name: name.value,
+            type: type.value
+        }
+    })
 </script>
 ```
 

From a575f9f4ae2242b55c9607463d942ffe2a6d3e4a Mon Sep 17 00:00:00 2001
From: Krutie Patel <krutie.patel@gmail.com>
Date: Mon, 4 Jul 2022 10:36:46 +1000
Subject: [PATCH 3/6] docs: fix indentation

---
 docs/content/3.api/3.utils/navigate-to.md | 28 +++++++++++------------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/docs/content/3.api/3.utils/navigate-to.md b/docs/content/3.api/3.utils/navigate-to.md
index c9e6f684115..0da5a15150b 100644
--- a/docs/content/3.api/3.utils/navigate-to.md
+++ b/docs/content/3.api/3.utils/navigate-to.md
@@ -16,20 +16,20 @@
 
 ```js
 <script setup>    
-    // string
-    return navigateTo('/search')
-
-    // route object
-    return navigateTo({ path: '/search' })
-    
-    // route object with query parameters
-    return navigateTo({
-        path: '/search',
-        query: {
-            name: name.value,
-            type: type.value
-        }
-    })
+// string
+return navigateTo('/search')
+
+// route object
+return navigateTo({ path: '/search' })
+
+// route object with query parameters
+return navigateTo({
+    path: '/search',
+    query: {
+        name: name.value,
+        type: type.value
+    }
+})
 </script>
 ```
 

From 9af40111cc3be190f620454bb1488d8ad5271ded Mon Sep 17 00:00:00 2001
From: Krutie Patel <krutie.patel@gmail.com>
Date: Mon, 4 Jul 2022 23:09:49 +1000
Subject: [PATCH 4/6] docs: fix typos

---
 docs/content/3.api/3.utils/navigate-to.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/content/3.api/3.utils/navigate-to.md b/docs/content/3.api/3.utils/navigate-to.md
index 0da5a15150b..1a6e1ddb3ce 100644
--- a/docs/content/3.api/3.utils/navigate-to.md
+++ b/docs/content/3.api/3.utils/navigate-to.md
@@ -39,7 +39,7 @@ return navigateTo({
 
 `navigateTo` redirects to the given path and sets the redirect code to `302` by default when the redirect takes place on the server side. 
 
-This default behaviour can be modified by providing different `redirectCode` as an optional parameter.
+This default behavior can be modified by providing different `redirectCode` as an optional parameter.
 
 ### Example: Route middleware
 
@@ -52,9 +52,9 @@ export default defineNuxtRouteMiddleware((to, from) => {
 
 - **replace:** type: boolean
 
-By default, `navigateTo` pushes the given route into Vue router instance on.
+By default, `navigateTo` pushes the given route into Vue router instance.
 
-This behaviour can be changed by setting `replace` to `true`, to indicate that given route should be replaced.
+This behavior can be changed by setting `replace` to `true`, to indicate that given route should be replaced.
 
 ```js
 <script setup>

From b2b8921215f5b7aa405b0abeea392532f18c576d Mon Sep 17 00:00:00 2001
From: Pooya Parsa <pooya@pi0.io>
Date: Thu, 7 Jul 2022 20:45:55 +0200
Subject: [PATCH 5/6] improvements

---
 .../3.directory-structure/7.middleware.md     | 19 ++++--
 docs/content/3.api/3.utils/navigate-to.md     | 61 ++++++++++++-------
 2 files changed, 53 insertions(+), 27 deletions(-)

diff --git a/docs/content/2.guide/3.directory-structure/7.middleware.md b/docs/content/2.guide/3.directory-structure/7.middleware.md
index 8f90cf9a21d..db0042b7468 100644
--- a/docs/content/2.guide/3.directory-structure/7.middleware.md
+++ b/docs/content/2.guide/3.directory-structure/7.middleware.md
@@ -41,10 +41,21 @@ Nuxt provides two globally available helpers that can be returned directly from
 Unlike navigation guards in [the vue-router docs](https://router.vuejs.org/guide/advanced/navigation-guards.html#global-before-guards), a third `next()` argument is not passed, and redirects or route cancellation is handled by returning a value from the middleware. Possible return values are:
 
 * nothing - does not block navigation and will move to the next middleware function, if any, or complete the route navigation
-* `navigateTo('/')` or `navigateTo({ path: '/' })` - redirects to the given path and will set the redirect code to [`302` Found](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302) if the redirect happens on the server side
-* `navigateTo('/', { redirectCode: 301 })` - redirects to the given path and will set the redirect code to [`301` Moved Permanently](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301) if the redirect happens on the server side
-* `abortNavigation()` - stops the current navigation
-* `abortNavigation(error)` - rejects the current navigation with an error
+* `return navigateTo('/')` or `return navigateTo({ path: '/' })` - redirects to the given path and will set the redirect code to [`302` Found](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302) if the redirect happens on the server side
+* `return navigateTo('/', { redirectCode: 301 })` - redirects to the given path and will set the redirect code to [`301` Moved Permanently](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301) if the redirect happens on the server side
+
+::ReadMore{link="/api/utils/navigate-to"}
+::
+
+* `return abortNavigation()` - stops the current navigation
+* `return abortNavigation(error)` - rejects the current navigation with an error
+
+::ReadMore{link="/api/utils/abort-navigation"}
+::
+
+::ReadMore{link="/guide/features/routing"}
+::
+
 
 ::alert{type=warning}
 We recommend using the helper functions above for performing redirects or stopping navigation. Other possible return values described in [the vue-router docs](https://router.vuejs.org/guide/advanced/navigation-guards.html#global-before-guards) may work but there may be breaking changes in future.
diff --git a/docs/content/3.api/3.utils/navigate-to.md b/docs/content/3.api/3.utils/navigate-to.md
index 1a6e1ddb3ce..fffe89da448 100644
--- a/docs/content/3.api/3.utils/navigate-to.md
+++ b/docs/content/3.api/3.utils/navigate-to.md
@@ -1,21 +1,28 @@
 # `navigateTo`
 
-`navigateTo` is a route helper function that allows creating programmatic navigation for users to navigate within Nuxt application.
+`navigateTo` is a router helper function that allows creating programmatic navigation for users to navigate within Nuxt application.
 
 `navigateTo` is available on both server side and client side. It can be used within plugins, middleware or can be called directly to perform page navigation.
 
-> While using `navigateTo`, make sure to use `await` or chain its result by returning from functions.
 
-## Required parameter
+## Usage
 
-`navigateTo` takes route as a required parameter that can be a plain string or a route object.
+```ts
+navigateTo (route: string | Route, { redirectCode = 302, replace = false })
+```
+
+`route` can be a plain string or a route object to redirect to.
 
-- **route:** type: string | Route
+::alert{type="warning"}
+Make sure to use always `await` or `return` on result of `navigateTo()` when calling it.
+::
 
-### Example: Vue component
+## Examples
 
-```js
-<script setup>    
+### Within a Vue component
+
+```vue
+<script setup>
 // string
 return navigateTo('/search')
 
@@ -33,15 +40,8 @@ return navigateTo({
 </script>
 ```
 
-## Optional parameters
-
-- **redirectCode:** type: number
 
-`navigateTo` redirects to the given path and sets the redirect code to `302` by default when the redirect takes place on the server side. 
-
-This default behavior can be modified by providing different `redirectCode` as an optional parameter.
-
-### Example: Route middleware
+### Within route middleware
 
 ```js
 export default defineNuxtRouteMiddleware((to, from) => {
@@ -50,17 +50,32 @@ export default defineNuxtRouteMiddleware((to, from) => {
 })
 ```
 
-- **replace:** type: boolean
-
-By default, `navigateTo` pushes the given route into Vue router instance.
-
-This behavior can be changed by setting `replace` to `true`, to indicate that given route should be replaced.
-
 ```js
 <script setup>
     await navigateTo('/', { replace: true })
 </script>
 ```
 
-::ReadMore{link="/guide/features/routing"}
+::ReadMore{link="/guide/directory-structure/middleware"}
 ::
+
+
+### Options
+
+#### `redirectCode`
+
+- Type: Number
+
+`navigateTo` redirects to the given path and sets the redirect code to [`302` Found](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302) by default when the redirect takes place on the server side.
+
+This default behavior can be modified by providing different `redirectCode` as an optional parameter. Commonly [`301` Moved Permanently](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301) can be used for permant redirections.
+
+
+#### `replace`
+
+- Type: Boolean
+
+By default, `navigateTo` pushes the given route into Vue router instance on client-side.
+
+This behavior can be changed by setting `replace` to `true`, to indicate that given route should be replaced.
+

From 905d463991e750780738f3d7ec92902ec3b4c60f Mon Sep 17 00:00:00 2001
From: Pooya Parsa <pooya@pi0.io>
Date: Thu, 7 Jul 2022 20:46:50 +0200
Subject: [PATCH 6/6] lint

---
 docs/content/2.guide/3.directory-structure/7.middleware.md | 1 -
 docs/content/3.api/3.utils/navigate-to.md                  | 5 -----
 2 files changed, 6 deletions(-)

diff --git a/docs/content/2.guide/3.directory-structure/7.middleware.md b/docs/content/2.guide/3.directory-structure/7.middleware.md
index db0042b7468..d25d3249833 100644
--- a/docs/content/2.guide/3.directory-structure/7.middleware.md
+++ b/docs/content/2.guide/3.directory-structure/7.middleware.md
@@ -56,7 +56,6 @@ Unlike navigation guards in [the vue-router docs](https://router.vuejs.org/guide
 ::ReadMore{link="/guide/features/routing"}
 ::
 
-
 ::alert{type=warning}
 We recommend using the helper functions above for performing redirects or stopping navigation. Other possible return values described in [the vue-router docs](https://router.vuejs.org/guide/advanced/navigation-guards.html#global-before-guards) may work but there may be breaking changes in future.
 ::
diff --git a/docs/content/3.api/3.utils/navigate-to.md b/docs/content/3.api/3.utils/navigate-to.md
index fffe89da448..636e3e5990b 100644
--- a/docs/content/3.api/3.utils/navigate-to.md
+++ b/docs/content/3.api/3.utils/navigate-to.md
@@ -4,7 +4,6 @@
 
 `navigateTo` is available on both server side and client side. It can be used within plugins, middleware or can be called directly to perform page navigation.
 
-
 ## Usage
 
 ```ts
@@ -40,7 +39,6 @@ return navigateTo({
 </script>
 ```
 
-
 ### Within route middleware
 
 ```js
@@ -59,7 +57,6 @@ export default defineNuxtRouteMiddleware((to, from) => {
 ::ReadMore{link="/guide/directory-structure/middleware"}
 ::
 
-
 ### Options
 
 #### `redirectCode`
@@ -70,7 +67,6 @@ export default defineNuxtRouteMiddleware((to, from) => {
 
 This default behavior can be modified by providing different `redirectCode` as an optional parameter. Commonly [`301` Moved Permanently](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301) can be used for permant redirections.
 
-
 #### `replace`
 
 - Type: Boolean
@@ -78,4 +74,3 @@ This default behavior can be modified by providing different `redirectCode` as a
 By default, `navigateTo` pushes the given route into Vue router instance on client-side.
 
 This behavior can be changed by setting `replace` to `true`, to indicate that given route should be replaced.
-