From ea158a56c8943fc6e81b18247ac15990e290e778 Mon Sep 17 00:00:00 2001
From: Daniel Roe <daniel@roe.dev>
Date: Thu, 4 May 2023 14:20:36 +0100
Subject: [PATCH] docs: ensure we guard all `navigateTo` examples

---
 docs/2.guide/2.directory-structure/1.middleware.md | 4 +++-
 docs/3.api/3.utils/abort-navigation.md             | 4 +++-
 docs/3.api/3.utils/define-nuxt-route-middleware.md | 4 +++-
 docs/3.api/3.utils/define-page-meta.md             | 4 +++-
 docs/3.api/3.utils/navigate-to.md                  | 6 ++++--
 5 files changed, 16 insertions(+), 6 deletions(-)

diff --git a/docs/2.guide/2.directory-structure/1.middleware.md b/docs/2.guide/2.directory-structure/1.middleware.md
index bad0a755a354..9b7ea6390d43 100644
--- a/docs/2.guide/2.directory-structure/1.middleware.md
+++ b/docs/2.guide/2.directory-structure/1.middleware.md
@@ -30,7 +30,9 @@ export default defineNuxtRouteMiddleware((to, from) => {
   if (to.params.id === '1') {
     return abortNavigation()
   }
-  return navigateTo('/')
+  if (to.path !== '/') {
+    return navigateTo('/')
+  }
 })
 ```
 
diff --git a/docs/3.api/3.utils/abort-navigation.md b/docs/3.api/3.utils/abort-navigation.md
index 9d3f96b0e0ee..7099c68f206b 100644
--- a/docs/3.api/3.utils/abort-navigation.md
+++ b/docs/3.api/3.utils/abort-navigation.md
@@ -36,7 +36,9 @@ export default defineNuxtRouteMiddleware((to, from) => {
     return abortNavigation()
   }
  
-  return navigateTo('/edit-post')
+  if (to.path !== '/edit-post') {
+    return navigateTo('/edit-post')
+  }
 })
 ```
 
diff --git a/docs/3.api/3.utils/define-nuxt-route-middleware.md b/docs/3.api/3.utils/define-nuxt-route-middleware.md
index 1ed6ff41cdac..9b7bb2939bf4 100644
--- a/docs/3.api/3.utils/define-nuxt-route-middleware.md
+++ b/docs/3.api/3.utils/define-nuxt-route-middleware.md
@@ -56,7 +56,9 @@ export default defineNuxtRouteMiddleware((to, from) => {
     return navigateTo('/login')
   }
 
-  return navigateTo('/dashboard')
+  if (to.path !== '/dashboard') {
+    return navigateTo('/dashboard')
+  }
 })
 ```
 
diff --git a/docs/3.api/3.utils/define-page-meta.md b/docs/3.api/3.utils/define-page-meta.md
index 7bfa3a9e9fd9..601a7e5a5b12 100644
--- a/docs/3.api/3.utils/define-page-meta.md
+++ b/docs/3.api/3.utils/define-page-meta.md
@@ -144,7 +144,9 @@ The example below shows how the middleware can be defined using a `function` dir
             return navigateTo('/login')
         }
 
-        return navigateTo('/checkout')
+        if (to.path !== '/checkout') {
+          return navigateTo('/checkout')
+        }
       }
     ],
 
diff --git a/docs/3.api/3.utils/navigate-to.md b/docs/3.api/3.utils/navigate-to.md
index 9587efe5c4b1..d922014bad55 100644
--- a/docs/3.api/3.utils/navigate-to.md
+++ b/docs/3.api/3.utils/navigate-to.md
@@ -96,8 +96,10 @@ await navigateTo({
 
 ```ts
 export default defineNuxtRouteMiddleware((to, from) => {
-  // setting the redirect code to '301 Moved Permanently'
-  return navigateTo('/search', { redirectCode: 301 })
+  if (to.path !== '/search') {
+    // setting the redirect code to '301 Moved Permanently'
+    return navigateTo('/search', { redirectCode: 301 })
+  }
 })
 ```