docs: added new guides and troubleshooting related to admin development (#8739)

2024-08-27 10:35:09 +02:00
1 parent 2bacf86d3c
commit 5996089c9c
@@ -0,0 +1,37 @@
+export const metadata = {
+  title: `Admin Widget / UI Route Not Showing`,
+}
+
+# {metadata.title}
+
+This guide provides some troubleshooting step as to why your admin widget / UI route isn't showing in the Medusa Admin dashboard.
+
+## Incorrect Zone
+
+If you're adding an admin widget, make sure you're using a correct zone.
+
+Refer to the [Admin Widget Injection Zones list](../../../admin-widget-injection-zones/page.mdx) for reference.
+
+---
+
+## Incorrect Function Definition
+
+Widget and UI routes must be defined as arrow functions. Any other type of declaration isn't accepted.
+
+Refer to the [Admin Development Constraints](!docs!/advanced-development/admin/constraints) documentation for more details.
+
+---
+
+## Incorrect Type of Zone Value
+
+A widget zone's value must be wrapped in double or single quotes:
+
+```ts
+export const config = defineWidgetConfig({
+  zone: "product.details.before",
+})
+```
+
+Any other usage leads to the widget not being shown.
+
+Refer to the [Admin Development Constraints](!docs!/advanced-development/admin/constraints) documentation for more details.
@@ -267,5 +267,6 @@ export const generatedEditDates = {
  "references/core_flows/Order/functions/core_flows.Order.updateOrderEditAddItemWorkflow/page.mdx": "2024-08-20T00:10:59.105Z",
  "references/core_flows/core_flows.Order/page.mdx": "2024-08-20T00:10:56.437Z",
  "references/modules/core_flows/page.mdx": "2024-08-20T00:10:49.141Z",
-  "references/types/types.HttpTypes/page.mdx": "2024-08-20T00:10:43.061Z"
+  "references/types/types.HttpTypes/page.mdx": "2024-08-20T00:10:43.061Z",
+  "app/troubleshooting/medusa-admin/no-widget-route/page.mdx": "2024-08-23T11:31:26.346Z"
 }
@@ -1007,6 +1007,10 @@ export const filesMap = [
    "filePath": "/www/apps/resources/app/troubleshooting/general-errors/page.mdx",
    "pathname": "/troubleshooting/general-errors"
  },
+  {
+    "filePath": "/www/apps/resources/app/troubleshooting/medusa-admin/no-widget-route/page.mdx",
+    "pathname": "/troubleshooting/medusa-admin/no-widget-route"
+  },
  {
    "filePath": "/www/apps/resources/app/troubleshooting/page.mdx",
    "pathname": "/troubleshooting"
@@ -8371,6 +8371,22 @@ export const generatedSidebar = [
              }
            ]
          },
+          {
+            "loaded": true,
+            "isPathHref": true,
+            "type": "category",
+            "title": "Admin Development",
+            "children": [
+              {
+                "loaded": true,
+                "isPathHref": true,
+                "type": "link",
+                "path": "/troubleshooting/medusa-admin/no-widget-route",
+                "title": "Widget or Route not Showing",
+                "children": []
+              }
+            ]
+          },
          {
            "loaded": true,
            "isPathHref": true,
@@ -2160,6 +2160,17 @@ export const sidebar = sidebarAttachHrefCommonOptions([
              },
            ],
          },
+          {
+            type: "category",
+            title: "Admin Development",
+            children: [
+              {
+                type: "link",
+                path: "/troubleshooting/medusa-admin/no-widget-route",
+                title: "Widget or Route not Showing",
+              },
+            ],
+          },
          {
            type: "category",
            title: "Upgrade",