From c102092bb68acd50d8a25563ae9f1ea966d2ad58 Mon Sep 17 00:00:00 2001
From: Alex Plischke <alex.plischke@saucelabs.com>
Date: Fri, 2 Aug 2024 14:12:34 -0700
Subject: [PATCH] docs: elaborate on smartRetry requirements for cypress
 (#2875)

---
 .../automated-testing/cypress/yaml/v1.md         | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/docs/web-apps/automated-testing/cypress/yaml/v1.md b/docs/web-apps/automated-testing/cypress/yaml/v1.md
index 9025048e37..b1340101ed 100644
--- a/docs/web-apps/automated-testing/cypress/yaml/v1.md
+++ b/docs/web-apps/automated-testing/cypress/yaml/v1.md
@@ -404,7 +404,7 @@ npm:
       auth: base64SecretToken
       username: myUsername
       password: myPassword
-      email: myEmail 
+      email: myEmail
 ```
 
 ---
@@ -707,7 +707,7 @@ artifacts:
 <p><small>| OPTIONAL | OBJECT |</small></p>
 
 Define directories to archive and retain as a test asset at the end of a test run. Archived test assets can
-be downloaded automatically using the `download` configuration, via the 
+be downloaded automatically using the `download` configuration, via the
 [REST API](/dev/api/jobs/#get-a-job-asset-file), or through the test details page.
 
 ```yaml
@@ -1231,7 +1231,7 @@ suite:
 
 <p><small>| OPTIONAL | OBJECT |</small></p>
 
-Specifies the retry strategy to apply for that suite. Requires [retries](#retries) to be >= 1.
+Specifies the retry strategy. Requires [retries](#retries) to be >= 1.
 
 ```yaml
 sauce:
@@ -1242,13 +1242,21 @@ suite:
       failedOnly: true
 ```
 
+:::note
+`smartRetry` relies on the Cypress plugin `@cypress/grep` to filter tests.
+Ensure that the plugin is installed and configured. Please refer to our
+[example repository](https://github.com/saucelabs/saucectl-cypress-example/tree/f8715d05d3f47bb033fbcb2d1086ef970dcb3030/v1/examples/cypress-grep)
+for more information.
+:::
+
 ---
 
 #### `failedOnly`
 
 <p><small>| OPTIONAL | BOOLEAN |</small></p>
 
-When set to `true`, only the tests that failed during the previous attempt are retried.
+When set to `true`, only the tests that failed during the previous attempt are
+retried.
 
 ```yaml
 suite: