Add note explaining preview params are optional (#306)

shorebirdtech · Oct 24, 2024 · ec449f3 · ec449f3
1 parent a0f671c
commit ec449f3
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/src/content/docs/guides/flavors/android.mdx b/src/content/docs/guides/flavors/android.mdx
@@ -110,6 +110,13 @@ shorebird preview --app-id ee322dc4-3dc2-4324-90a9-04c40a62ae76 --release-versio
 shorebird preview --app-id 904bd3d5-3526-4c1c-a832-7ac23c95302d --release-version 1.0.0+1
 ```
 
+:::note
+
+`--app-id` and `--release-version` are optional parameters. If not provided, you
+will be prompted to select the app and release version interactively.
+
+:::
+
 This will download the releases and run them on your device.
 
 In addition to previewing the releases locally, you should also [submit the

diff --git a/src/content/docs/guides/flavors/ios.mdx b/src/content/docs/guides/flavors/ios.mdx
@@ -79,6 +79,13 @@ shorebird preview --app-id ee322dc4-3dc2-4324-90a9-04c40a62ae76 --release-versio
 shorebird preview --app-id 904bd3d5-3526-4c1c-a832-7ac23c95302d --release-version 1.0.0+1
 ```
 
+:::note
+
+`--app-id` and `--release-version` are optional parameters. If not provided, you
+will be prompted to select the app and release version interactively.
+
+:::
+
 This will download the releases and run them on your device.
 
 In addition to previewing the releases locally, you should also [submit the