added tools section

This commit is contained in:
Shahed Nasser
2025-03-10 14:41:02 +02:00
parent d2c4323299
commit 11db301f9b
12 changed files with 959 additions and 831 deletions

View File

@@ -14,7 +14,7 @@ Learn more about Medusa's architecture in [this documentation](!docs!/learn/intr
</Note>
You can build your storefront from scratch, or built it on top of the [Next.js Starter storefront](../nextjs-starter/page.mdx). This section of the documentation provides guides to help you build a storefront from scratch for your Medusa application.
You can build your storefront from scratch, or build it on top of the [Next.js Starter storefront](../nextjs-starter/page.mdx). This section of the documentation provides guides to help you build a storefront from scratch for your Medusa application.
<ChildDocs showItems={["General"]} />

View File

@@ -0,0 +1,13 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Tools`,
}
# {metadata.title}
In this section of the documentation, you'll find tools that are useful for your development as you build a commerce application with Medusa. You'll find CLI tools, SDKs, storefront starters, and more.
For each of these tools, you'll learn how to set them up and use them in your project.
<ChildDocs hideItems={["Overview", "Medusa UI"]} />

View File

@@ -177,7 +177,7 @@ export const generatedEditDates = {
"app/storefront-development/regions/store-retrieve-region/page.mdx": "2024-12-19T16:36:22.800Z",
"app/storefront-development/regions/page.mdx": "2024-06-09T15:19:09+02:00",
"app/storefront-development/tips/page.mdx": "2024-12-19T16:36:32.938Z",
"app/storefront-development/page.mdx": "2025-03-07T07:49:27.809Z",
"app/storefront-development/page.mdx": "2025-03-10T12:26:51.415Z",
"app/troubleshooting/cors-errors/page.mdx": "2024-05-03T17:36:38+03:00",
"app/troubleshooting/create-medusa-app-errors/page.mdx": "2024-07-11T10:29:13+03:00",
"app/troubleshooting/database-errors/page.mdx": "2024-05-03T17:36:38+03:00",
@@ -6040,5 +6040,6 @@ export const generatedEditDates = {
"references/core_flows/types/core_flows.RefreshCartShippingMethodsWorkflowInput/page.mdx": "2025-03-04T13:33:46.133Z",
"references/core_flows/types/core_flows.ValidateExistingPaymentCollectionStepInput/page.mdx": "2025-03-04T13:33:46.130Z",
"references/types/interfaces/types.ITaxProvider/page.mdx": "2025-03-04T13:33:52.645Z",
"app/how-to-tutorials/page.mdx": "2025-03-10T09:33:49.208Z"
"app/how-to-tutorials/page.mdx": "2025-03-10T09:33:49.208Z",
"app/tools/page.mdx": "2025-03-10T12:38:56.520Z"
}

View File

@@ -1211,6 +1211,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/test-tools-reference/page.mdx",
"pathname": "/test-tools-reference"
},
{
"filePath": "/www/apps/resources/app/tools/page.mdx",
"pathname": "/tools"
},
{
"filePath": "/www/apps/resources/app/troubleshooting/cors-errors/page.mdx",
"pathname": "/troubleshooting/cors-errors"

View File

@@ -18,6 +18,7 @@ const generatedgeneratedIntegrationsSidebarSidebar = {
"isPathHref": true,
"type": "category",
"title": "Auth",
"initialOpen": true,
"children": [
{
"loaded": true,
@@ -42,6 +43,7 @@ const generatedgeneratedIntegrationsSidebarSidebar = {
"isPathHref": true,
"type": "category",
"title": "CMS",
"initialOpen": true,
"children": [
{
"loaded": true,
@@ -58,6 +60,7 @@ const generatedgeneratedIntegrationsSidebarSidebar = {
"isPathHref": true,
"type": "category",
"title": "ERP",
"initialOpen": true,
"children": [
{
"loaded": true,
@@ -74,6 +77,7 @@ const generatedgeneratedIntegrationsSidebarSidebar = {
"isPathHref": true,
"type": "category",
"title": "File",
"initialOpen": true,
"children": [
{
"loaded": true,
@@ -90,6 +94,7 @@ const generatedgeneratedIntegrationsSidebarSidebar = {
"isPathHref": true,
"type": "category",
"title": "Fulfillment",
"initialOpen": true,
"children": [
{
"loaded": true,
@@ -106,6 +111,7 @@ const generatedgeneratedIntegrationsSidebarSidebar = {
"isPathHref": true,
"type": "category",
"title": "Notification",
"initialOpen": true,
"children": [
{
"loaded": true,
@@ -130,6 +136,7 @@ const generatedgeneratedIntegrationsSidebarSidebar = {
"isPathHref": true,
"type": "category",
"title": "Payment",
"initialOpen": true,
"children": [
{
"loaded": true,

View File

@@ -17164,745 +17164,6 @@ const generatedgeneratedResourcesSidebarSidebar = {
{
"type": "separator"
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "SDKs and Tools",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/create-medusa-app",
"title": "create-medusa-app",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "sidebar",
"sidebar_id": "medusa-cli",
"title": "Medusa CLI",
"childSidebarTitle": "Medusa CLI Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli",
"title": "Overview",
"children": []
},
{
"type": "separator"
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Commands",
"autogenerate_path": "medusa-cli/commands",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/new",
"title": "new",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/develop",
"title": "develop",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/start",
"title": "start",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/user",
"title": "user",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/build",
"title": "build",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/db",
"title": "db",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/plugin",
"title": "plugin",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/exec",
"title": "exec",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/start-cluster",
"title": "start-cluster",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/telemtry",
"title": "telemetry",
"description": "",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "sidebar",
"sidebar_id": "js-sdk",
"title": "JS SDK",
"childSidebarTitle": "JS SDK Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/js-sdk",
"title": "Overview",
"children": []
},
{
"type": "separator"
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Auth",
"autogenerate_path": "/references/js_sdk/auth/Auth/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/auth/callback",
"title": "callback",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/auth/login",
"title": "login",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/auth/logout",
"title": "logout",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/auth/refresh",
"title": "refresh",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/auth/register",
"title": "register",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/auth/resetPassword",
"title": "resetPassword",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/auth/updateProvider",
"title": "updateProvider",
"description": "",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Store",
"autogenerate_path": "/references/js_sdk/store/Store/properties",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/cart",
"title": "cart",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/category",
"title": "category",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/collection",
"title": "collection",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/customer",
"title": "customer",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/fulfillment",
"title": "fulfillment",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/order",
"title": "order",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/payment",
"title": "payment",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/product",
"title": "product",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/region",
"title": "region",
"description": "",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Admin",
"autogenerate_path": "/references/js_sdk/admin/Admin/properties",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/apiKey",
"title": "apiKey",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/campaign",
"title": "campaign",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/claim",
"title": "claim",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/currency",
"title": "currency",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/customer",
"title": "customer",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/customerGroup",
"title": "customerGroup",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/draftOrder",
"title": "draftOrder",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/exchange",
"title": "exchange",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/fulfillment",
"title": "fulfillment",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/fulfillmentProvider",
"title": "fulfillmentProvider",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/fulfillmentSet",
"title": "fulfillmentSet",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/inventoryItem",
"title": "inventoryItem",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/invite",
"title": "invite",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/notification",
"title": "notification",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/order",
"title": "order",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/orderEdit",
"title": "orderEdit",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/payment",
"title": "payment",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/paymentCollection",
"title": "paymentCollection",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/priceList",
"title": "priceList",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/pricePreference",
"title": "pricePreference",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/product",
"title": "product",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/productCategory",
"title": "productCategory",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/productCollection",
"title": "productCollection",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/productTag",
"title": "productTag",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/productType",
"title": "productType",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/productVariant",
"title": "productVariant",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/promotion",
"title": "promotion",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/refundReason",
"title": "refundReason",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/region",
"title": "region",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/reservation",
"title": "reservation",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/return",
"title": "return",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/returnReason",
"title": "returnReason",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/salesChannel",
"title": "salesChannel",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/shippingOption",
"title": "shippingOption",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/shippingProfile",
"title": "shippingProfile",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/stockLocation",
"title": "stockLocation",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/store",
"title": "store",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/taxRate",
"title": "taxRate",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/taxRegion",
"title": "taxRegion",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/upload",
"title": "upload",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/user",
"title": "user",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/workflowExecution",
"title": "workflowExecution",
"description": "",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "sidebar",
"sidebar_id": "nextjs-starter",
"title": "Next.js Starter Storefront",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/nextjs-starter",
"title": "Overview",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Payment",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/nextjs-starter/guides/customize-stripe",
"title": "Customize Stripe Integration",
"children": []
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,

View File

@@ -0,0 +1,785 @@
const generatedgeneratedToolsSidebarSidebar = {
"sidebar_id": "tools",
"title": "Tools",
"items": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"title": "Overview",
"path": "/tools",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "CLI Tools",
"initialOpen": true,
"description": "CLI tools help you setup Medusa, manage the database, and more.",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/create-medusa-app",
"title": "create-medusa-app",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "sidebar",
"sidebar_id": "medusa-cli",
"title": "Medusa CLI",
"childSidebarTitle": "Medusa CLI Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli",
"title": "Overview",
"children": []
},
{
"type": "separator"
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Commands",
"autogenerate_path": "medusa-cli/commands",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/new",
"title": "new",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/develop",
"title": "develop",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/start",
"title": "start",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/user",
"title": "user",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/build",
"title": "build",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/db",
"title": "db",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/plugin",
"title": "plugin",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/exec",
"title": "exec",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/start-cluster",
"title": "start-cluster",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/medusa-cli/commands/telemtry",
"title": "telemetry",
"description": "",
"children": []
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "SDKs",
"initialOpen": true,
"description": "SDKs help you build client applications, such as storefronts or admin dashboards, with Medusa. They're also useful when extending the Medusa Admin with widgets and UI routes.",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "sidebar",
"sidebar_id": "js-sdk",
"title": "JS SDK",
"childSidebarTitle": "JS SDK Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/js-sdk",
"title": "Overview",
"children": []
},
{
"type": "separator"
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Auth",
"autogenerate_path": "/references/js_sdk/auth/Auth/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/auth/callback",
"title": "callback",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/auth/login",
"title": "login",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/auth/logout",
"title": "logout",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/auth/refresh",
"title": "refresh",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/auth/register",
"title": "register",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/auth/resetPassword",
"title": "resetPassword",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/auth/updateProvider",
"title": "updateProvider",
"description": "",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Store",
"autogenerate_path": "/references/js_sdk/store/Store/properties",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/cart",
"title": "cart",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/category",
"title": "category",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/collection",
"title": "collection",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/customer",
"title": "customer",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/fulfillment",
"title": "fulfillment",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/order",
"title": "order",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/payment",
"title": "payment",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/product",
"title": "product",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/store/region",
"title": "region",
"description": "",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Admin",
"autogenerate_path": "/references/js_sdk/admin/Admin/properties",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/apiKey",
"title": "apiKey",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/campaign",
"title": "campaign",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/claim",
"title": "claim",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/currency",
"title": "currency",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/customer",
"title": "customer",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/customerGroup",
"title": "customerGroup",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/draftOrder",
"title": "draftOrder",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/exchange",
"title": "exchange",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/fulfillment",
"title": "fulfillment",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/fulfillmentProvider",
"title": "fulfillmentProvider",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/fulfillmentSet",
"title": "fulfillmentSet",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/inventoryItem",
"title": "inventoryItem",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/invite",
"title": "invite",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/notification",
"title": "notification",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/order",
"title": "order",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/orderEdit",
"title": "orderEdit",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/payment",
"title": "payment",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/paymentCollection",
"title": "paymentCollection",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/priceList",
"title": "priceList",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/pricePreference",
"title": "pricePreference",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/product",
"title": "product",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/productCategory",
"title": "productCategory",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/productCollection",
"title": "productCollection",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/productTag",
"title": "productTag",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/productType",
"title": "productType",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/productVariant",
"title": "productVariant",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/promotion",
"title": "promotion",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/refundReason",
"title": "refundReason",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/region",
"title": "region",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/reservation",
"title": "reservation",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/return",
"title": "return",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/returnReason",
"title": "returnReason",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/salesChannel",
"title": "salesChannel",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/shippingOption",
"title": "shippingOption",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/shippingProfile",
"title": "shippingProfile",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/stockLocation",
"title": "stockLocation",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/store",
"title": "store",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/taxRate",
"title": "taxRate",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/taxRegion",
"title": "taxRegion",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/upload",
"title": "upload",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/user",
"title": "user",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/js-sdk/admin/workflowExecution",
"title": "workflowExecution",
"description": "",
"children": []
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Storefront Starters",
"initialOpen": true,
"description": "A storefront starter is a storefront with the basic commerce features that you can use with your Medusa application. You can use it as-is or build on top of it. Learn more about building a storefront in the [Storefront Development](/storefront-development) documentation.",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "sidebar",
"sidebar_id": "nextjs-starter",
"title": "Next.js Starter Storefront",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/nextjs-starter",
"title": "Overview",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Payment",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/nextjs-starter/guides/customize-stripe",
"title": "Customize Stripe Integration",
"children": []
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "external",
"title": "Medusa UI",
"path": "https://docs.medusajs.com/ui",
"children": []
}
]
}
export default generatedgeneratedToolsSidebarSidebar

View File

@@ -17,7 +17,7 @@ import { recipesSidebar } from "./sidebars/recipes.mjs"
import { referencesSidebar } from "./sidebars/references.mjs"
import { regionSidebar } from "./sidebars/region.mjs"
import { salesChannelSidebar } from "./sidebars/sales-channel.mjs"
import { sdkToolsSidebar } from "./sidebars/sdk-tools.mjs"
import { toolsSidebar } from "./sidebars/tools.mjs"
import { stockLocationSidebar } from "./sidebars/stock-location.mjs"
import { storeSidebar } from "./sidebars/store.mjs"
import { storefrontDevelopmentSidebar } from "./sidebars/storefront.mjs"
@@ -74,11 +74,6 @@ export const sidebar = [
{
type: "separator",
},
{
type: "category",
title: "SDKs and Tools",
children: sdkToolsSidebar,
},
{
type: "category",
title: "General",
@@ -138,4 +133,9 @@ export const sidebar = [
title: "Storefront Development",
items: storefrontDevelopmentSidebar,
},
{
sidebar_id: "tools",
title: "Tools",
items: toolsSidebar,
},
]

View File

@@ -11,6 +11,7 @@ export const integrationsSidebar = [
{
type: "category",
title: "Auth",
initialOpen: true,
children: [
{
type: "ref",
@@ -27,6 +28,7 @@ export const integrationsSidebar = [
{
type: "category",
title: "CMS",
initialOpen: true,
children: [
{
type: "link",
@@ -38,6 +40,7 @@ export const integrationsSidebar = [
{
type: "category",
title: "ERP",
initialOpen: true,
children: [
{
type: "ref",
@@ -49,6 +52,7 @@ export const integrationsSidebar = [
{
type: "category",
title: "File",
initialOpen: true,
children: [
{
type: "ref",
@@ -60,6 +64,7 @@ export const integrationsSidebar = [
{
type: "category",
title: "Fulfillment",
initialOpen: true,
children: [
{
type: "link",
@@ -71,6 +76,7 @@ export const integrationsSidebar = [
{
type: "category",
title: "Notification",
initialOpen: true,
children: [
{
type: "link",
@@ -87,6 +93,7 @@ export const integrationsSidebar = [
{
type: "category",
title: "Payment",
initialOpen: true,
children: [
{
type: "ref",

View File

@@ -1,83 +0,0 @@
/** @type {import('types').Sidebar.SidebarItem[]} */
export const sdkToolsSidebar = [
{
type: "link",
path: "/create-medusa-app",
title: "create-medusa-app",
},
{
type: "sidebar",
sidebar_id: "medusa-cli",
title: "Medusa CLI",
childSidebarTitle: "Medusa CLI Reference",
children: [
{
type: "link",
path: "/medusa-cli",
title: "Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Commands",
autogenerate_path: "medusa-cli/commands",
},
],
},
{
type: "sidebar",
sidebar_id: "js-sdk",
title: "JS SDK",
childSidebarTitle: "JS SDK Reference",
children: [
{
type: "link",
path: "/js-sdk",
title: "Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Auth",
autogenerate_path: "/references/js_sdk/auth/Auth/methods",
},
{
type: "category",
title: "Store",
autogenerate_path: "/references/js_sdk/store/Store/properties",
},
{
type: "category",
title: "Admin",
autogenerate_path: "/references/js_sdk/admin/Admin/properties",
},
],
},
{
type: "sidebar",
sidebar_id: "nextjs-starter",
title: "Next.js Starter Storefront",
children: [
{
type: "link",
path: "/nextjs-starter",
title: "Overview",
},
{
type: "category",
title: "Payment",
children: [
{
type: "link",
path: "/nextjs-starter/guides/customize-stripe",
title: "Customize Stripe Integration",
},
],
},
],
},
]

View File

@@ -0,0 +1,120 @@
/** @type {import('types').Sidebar.SidebarItem[]} */
export const toolsSidebar = [
{
type: "link",
title: "Overview",
path: "/tools",
},
{
type: "category",
title: "CLI Tools",
initialOpen: true,
description:
"CLI tools help you setup Medusa, manage the database, and more.",
children: [
{
type: "link",
path: "/create-medusa-app",
title: "create-medusa-app",
},
{
type: "sidebar",
sidebar_id: "medusa-cli",
title: "Medusa CLI",
childSidebarTitle: "Medusa CLI Reference",
children: [
{
type: "link",
path: "/medusa-cli",
title: "Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Commands",
autogenerate_path: "medusa-cli/commands",
},
],
},
],
},
{
type: "category",
title: "SDKs",
initialOpen: true,
description:
"SDKs help you build client applications, such as storefronts or admin dashboards, with Medusa. They're also useful when extending the Medusa Admin with widgets and UI routes.",
children: [
{
type: "sidebar",
sidebar_id: "js-sdk",
title: "JS SDK",
childSidebarTitle: "JS SDK Reference",
children: [
{
type: "link",
path: "/js-sdk",
title: "Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Auth",
autogenerate_path: "/references/js_sdk/auth/Auth/methods",
},
{
type: "category",
title: "Store",
autogenerate_path: "/references/js_sdk/store/Store/properties",
},
{
type: "category",
title: "Admin",
autogenerate_path: "/references/js_sdk/admin/Admin/properties",
},
],
},
],
},
{
type: "category",
title: "Storefront Starters",
initialOpen: true,
description:
"A storefront starter is a storefront with the basic commerce features that you can use with your Medusa application. You can use it as-is or build on top of it. Learn more about building a storefront in the [Storefront Development](/storefront-development) documentation.",
children: [
{
type: "sidebar",
sidebar_id: "nextjs-starter",
title: "Next.js Starter Storefront",
children: [
{
type: "link",
path: "/nextjs-starter",
title: "Overview",
},
{
type: "category",
title: "Payment",
children: [
{
type: "link",
path: "/nextjs-starter/guides/customize-stripe",
title: "Customize Stripe Integration",
},
],
},
],
},
],
},
{
type: "external",
title: "Medusa UI",
path: "https://docs.medusajs.com/ui",
},
]

View File

@@ -43,6 +43,19 @@ const sidebarMappings: {
) as Promise<{ default: Sidebar.Sidebar }>,
paths: ["/storefront-development"],
},
{
module: async () =>
import("@/generated/generated-tools-sidebar.mjs") as Promise<{
default: Sidebar.Sidebar
}>,
paths: [
"/tools",
"/create-medusa-app",
"/medusa-cli",
"/js-sdk",
"/nextjs-starter",
],
},
]
export async function getSidebarForPath(
currentPath: string