Merge pull request #453 from Shopify/tweak_remix_docs

Chore: tweak Remix package docs
Shopify · Sep 25, 2023 · 1bd2032 · 1bd2032
2 parents 903589e + 6410b25
commit 1bd2032
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 6 deletions.
diff --git a/.changeset/pink-trainers-try.md b/.changeset/pink-trainers-try.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/packages/shopify-app-remix/docs/generated/generated_docs_data.json b/packages/shopify-app-remix/docs/generated/generated_docs_data.json
@@ -2169,14 +2169,14 @@
               {
                 "filePath": "/server/types.ts",
                 "syntaxKind": "MethodSignature",
-                "name": "__@iterator@527",
+                "name": "__@iterator@526",
                 "value": "() => IterableIterator<JSONValue>",
                 "description": "Iterator"
               },
               {
                 "filePath": "/server/types.ts",
                 "syntaxKind": "MethodSignature",
-                "name": "__@unscopables@529",
+                "name": "__@unscopables@528",
                 "value": "() => { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean; }",
                 "description": "Returns an object whose properties have the value 'true'\r\nwhen they will be absent when used in a 'with' statement."
               },
@@ -4546,14 +4546,14 @@
               {
                 "filePath": "/server/types.ts",
                 "syntaxKind": "MethodSignature",
-                "name": "__@iterator@527",
+                "name": "__@iterator@526",
                 "value": "() => IterableIterator<JSONValue>",
                 "description": "Iterator"
               },
               {
                 "filePath": "/server/types.ts",
                 "syntaxKind": "MethodSignature",
-                "name": "__@unscopables@529",
+                "name": "__@unscopables@528",
                 "value": "() => { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean; }",
                 "description": "Returns an object whose properties have the value 'true'\r\nwhen they will be absent when used in a 'with' statement."
               },

diff --git a/packages/shopify-app-remix/docs/generated/generated_static_pages.json b/packages/shopify-app-remix/docs/generated/generated_static_pages.json
@@ -2,7 +2,7 @@
   {
     "id": "guide-admin",
     "title": "Interacting with Shopify Admin",
-    "description": "Once you [set up your backend](/docs/api/shopify-app-remix#backend), you can use the [`authenticate.admin` function](/docs/api/shopify-app-remix/backend/authenticate-admin) to integrate your app with Shopify Admin.\n\nThis function works for both embedded and non-embedded apps, and ensures the app is installed on the current store.\n\nIt returns a context with functions to enable loaders and actions to respond to any requests made by or in Shopify Admin.\n\nThis page goes over the basics of authenticating those requests, and some of the things you can do with it, like querying the Admin API.",
+    "description": "Once you [set up your backend](/docs/api/shopify-app-remix#shopify-app), you can use the [`authenticate.admin` function](/docs/api/shopify-app-remix/authenticate/admin) to integrate your app with Shopify Admin.\n\nThis function works for both embedded and non-embedded apps, and ensures the app is installed on the current store.\n\nIt returns a context with functions to enable loaders and actions to respond to any requests made by or in Shopify Admin.\n\nThis page goes over the basics of authenticating those requests, and some of the things you can do with it, like querying the Admin API.",
     "sections": [
       {
         "type": "Generic",

diff --git a/packages/shopify-app-remix/docs/staticPages/admin.doc.ts b/packages/shopify-app-remix/docs/staticPages/admin.doc.ts
@@ -4,7 +4,7 @@ const data: LandingTemplateSchema = {
   id: 'guide-admin',
   title: 'Interacting with Shopify Admin',
   description:
-    'Once you [set up your backend](/docs/api/shopify-app-remix#backend), you can use the [`authenticate.admin` function](/docs/api/shopify-app-remix/backend/authenticate-admin) to integrate your app with Shopify Admin.' +
+    'Once you [set up your backend](/docs/api/shopify-app-remix#shopify-app), you can use the [`authenticate.admin` function](/docs/api/shopify-app-remix/authenticate/admin) to integrate your app with Shopify Admin.' +
     '\n\nThis function works for both embedded and non-embedded apps, and ensures the app is installed on the current store.' +
     '\n\nIt returns a context with functions to enable loaders and actions to respond to any requests made by or in Shopify Admin.' +
     '\n\nThis page goes over the basics of authenticating those requests, and some of the things you can do with it, like querying the Admin API.',