Improve intros in unauthenticated docs

.changeset/sixty-pans-wave.md

@@ -0,0 +1,2 @@
+---
+---

packages/shopify-app-remix/docs/generated/generated_docs_data.json

@@ -16,6 +16,14 @@
             "name": "AppProviderProps",
             "description": "",
             "members": [
+              {
+                "filePath": "../../node_modules/@shopify/polaris/build/ts/src/components/AppProvider/AppProvider.d.ts",
+                "syntaxKind": "PropertySignature",
+                "name": "theme",
+                "value": "ThemeName",
+                "description": "",
+                "isOptional": true
+              },
               {
                 "filePath": "../../node_modules/@shopify/polaris/build/ts/src/components/AppProvider/AppProvider.d.ts",
                 "syntaxKind": "PropertySignature",
@@ -48,7 +56,7 @@
                 "isOptional": true
               }
             ],
-            "value": "export interface AppProviderProps {\n    /** A locale object or array of locale objects that overrides default translations. If specifying an array then your primary language dictionary should come first, followed by your fallback language dictionaries */\n    i18n: ConstructorParameters<typeof I18n>[0];\n    /** A custom component to use for all links used by Polaris components */\n    linkComponent?: LinkLikeComponent;\n    /** For toggling features */\n    features?: FeaturesConfig;\n    /** Inner content of the application */\n    children?: React.ReactNode;\n}"
+            "value": "export interface AppProviderProps {\n    theme?: ThemeName;\n    /** A locale object or array of locale objects that overrides default translations. If specifying an array then your primary language dictionary should come first, followed by your fallback language dictionaries */\n    i18n: ConstructorParameters<typeof I18n>[0];\n    /** A custom component to use for all links used by Polaris components */\n    linkComponent?: LinkLikeComponent;\n    /** For toggling features */\n    features?: FeaturesConfig;\n    /** Inner content of the application */\n    children?: React.ReactNode;\n}"
           },
           "TranslationDictionary": {
             "filePath": "../../node_modules/@shopify/polaris/build/ts/src/utilities/i18n/I18n.d.ts",
@@ -79,25 +87,9 @@
                 "filePath": "../../node_modules/@shopify/polaris/build/ts/src/utilities/features/types.d.ts",
                 "name": "[key: string]",
                 "value": "boolean | undefined"
-              },
-              {
-                "filePath": "../../node_modules/@shopify/polaris/build/ts/src/utilities/features/types.d.ts",
-                "syntaxKind": "PropertySignature",
-                "name": "polarisSummerEditions2023",
-                "value": "boolean",
-                "description": "",
-                "isOptional": true
-              },
-              {
-                "filePath": "../../node_modules/@shopify/polaris/build/ts/src/utilities/features/types.d.ts",
-                "syntaxKind": "PropertySignature",
-                "name": "polarisSummerEditions2023ShadowBevelOptOut",
-                "value": "boolean",
-                "description": "",
-                "isOptional": true
               }
             ],
-            "value": "export interface FeaturesConfig {\n    polarisSummerEditions2023?: boolean;\n    polarisSummerEditions2023ShadowBevelOptOut?: boolean;\n    [key: string]: boolean | undefined;\n}"
+            "value": "export interface FeaturesConfig {\n    [key: string]: boolean | undefined;\n}"
           }
         }
       }
@@ -14700,7 +14692,7 @@
   },
   {
     "name": "Unauthenticated admin",
-    "description": "Allows interacting with the Admin API on requests that didn't come from Shopify.\n\n> Caution: This should only be used for Requests that do not originate from Shopify.\n> You must do your own authentication before using this method.\n>This function doesn't perform **any** validation and shouldn't rely on unvalidated user input.",
+    "description": "Allows interacting with the Admin API when working outside of Shopify requests.\nThis enables apps to integrate with 3rd party services and perform background tasks.\n\n> Caution:\n> This function doesn't perform **any** validation and shouldn't rely on raw user input.\n\nWhen using this function, consider the following:\n\n#### Background tasks\n\nApps should ensure that the shop domain is authenticated when enqueueing jobs.\n\n#### 3rd party service requests\n\nApps must obtain the shop domain from the 3rd party service in a secure way.",
     "category": "Unauthenticated",
     "type": "object",
     "isVisualComponent": false,
@@ -15448,7 +15440,7 @@
   },
   {
     "name": "Unauthenticated storefront",
-    "description": "Allows interacting with the Storefront API on requests that didn't come from Shopify.\n\n> Caution: This should only be used for Requests that do not originate from Shopify.\n> You must do your own authentication before using this method.\n>This function doesn't perform **any** validation and shouldn't rely on unvalidated user input.",
+    "description": "Allows interacting with the Storefront API when working outside of Shopify requests.\nThis enables apps to integrate with 3rd party services and perform background tasks.\n\n> Caution:\n> This function doesn't perform **any** validation and shouldn't rely on raw user input.\n\nWhen using this function, consider the following:\n\n#### Background tasks\n\nApps should ensure that the shop domain is authenticated when enqueueing jobs.\n\n#### 3rd party service requests\n\nApps must obtain the shop domain from the 3rd party service in a secure way.",
     "category": "Unauthenticated",
     "type": "object",
     "isVisualComponent": false,

packages/shopify-app-remix/src/server/unauthenticated/admin/unauthenticated.admin.doc.ts

@@ -2,11 +2,21 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'Unauthenticated admin',
-  description:
-    "Allows interacting with the Admin API on requests that didn't come from Shopify." +
-    '\n\n> Caution: This should only be used for Requests that do not originate from Shopify.' +
-    '\n> You must do your own authentication before using this method.' +
-    "\n>This function doesn't perform **any** validation and shouldn't rely on unvalidated user input.",
+  description: `Allows interacting with the Admin API when working outside of Shopify requests.
+This enables apps to integrate with 3rd party services and perform background tasks.
+
+> Caution:
+> This function doesn't perform **any** validation and shouldn't rely on raw user input.
+
+When using this function, consider the following:
+
+#### Background tasks
+
+Apps should ensure that the shop domain is authenticated when enqueueing jobs.
+
+#### 3rd party service requests
+
+Apps must obtain the shop domain from the 3rd party service in a secure way.`,
   category: 'Unauthenticated',
   type: 'object',
   isVisualComponent: false,

packages/shopify-app-remix/src/server/unauthenticated/storefront/unauthenticated.storefront.doc.ts

@@ -2,11 +2,21 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'Unauthenticated storefront',
-  description:
-    "Allows interacting with the Storefront API on requests that didn't come from Shopify." +
-    '\n\n> Caution: This should only be used for Requests that do not originate from Shopify.' +
-    '\n> You must do your own authentication before using this method.' +
-    "\n>This function doesn't perform **any** validation and shouldn't rely on unvalidated user input.",
+  description: `Allows interacting with the Storefront API when working outside of Shopify requests.
+This enables apps to integrate with 3rd party services and perform background tasks.
+
+> Caution:
+> This function doesn't perform **any** validation and shouldn't rely on raw user input.
+
+When using this function, consider the following:
+
+#### Background tasks
+
+Apps should ensure that the shop domain is authenticated when enqueueing jobs.
+
+#### 3rd party service requests
+
+Apps must obtain the shop domain from the 3rd party service in a secure way.`,
   category: 'Unauthenticated',
   type: 'object',
   isVisualComponent: false,