asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: add sidebar sorting logic (#11751)

Browse Source 
* docs: add sidebar sorting logic

* generate sidebar
This commit is contained in:
Shahed Nasser
2025-03-06 12:20:03 +02:00
committed by GitHub
parent ecc3deb362
commit 3616003145
28 changed files with 1959 additions and 1656 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/app/storefront-development/guides/express-checkout/page.mdx
-1
View File
@@ -1,7 +1,6 @@
---
tags:
- storefront
- js sdk
- cart
- product
- payment
www/apps/resources/generated/sidebar.mjs
+1728 -1625
View File
File diff suppressed because it is too large Load Diff
www/apps/resources/sidebar.mjs
+3
View File
@@ -50,6 +50,7 @@ export const sidebar = sidebarAttachHrefCommonOptions([
path: "/commerce-modules",
title: "Commerce Modules",
hideChildren: true,
sort_sidebar: "alphabetize",
children: [
...apiKeySidebar,
...authSidebar,
@@ -76,6 +77,7 @@ export const sidebar = sidebarAttachHrefCommonOptions([
path: "/architectural-modules",
title: "Architectural Modules",
isChildSidebar: true,
sort_sidebar: "alphabetize",
children: architecturalModulesSidebar,
},
{
@@ -83,6 +85,7 @@ export const sidebar = sidebarAttachHrefCommonOptions([
path: "/integrations",
title: "Integrations",
isChildSidebar: true,
sort_sidebar: "alphabetize",
children: integrationsSidebar,
},
{
www/apps/resources/sidebars/api-key.mjs
+8
View File
@@ -36,6 +36,7 @@ export const apiKeySidebar = [
autogenerate_tags: "server+auth",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the API Key Module in your customizations on the Medusa application server.",
},
@@ -45,6 +46,7 @@ export const apiKeySidebar = [
initialOpen: false,
autogenerate_tags: "storefront+apiKey,-jsSdk",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the API Key Module's features into your storefront.",
},
@@ -54,6 +56,7 @@ export const apiKeySidebar = [
initialOpen: false,
autogenerate_tags: "admin+apiKey,-jsSdk",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the API Key Module.",
},
@@ -63,6 +66,7 @@ export const apiKeySidebar = [
initialOpen: false,
autogenerate_tags: "userGuide+apiKey",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage API Key features in the Medusa Admin dashboard.",
},
@@ -84,12 +88,14 @@ export const apiKeySidebar = [
title: "Workflows",
autogenerate_tags: "workflow+apiKey",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+apiKey",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -106,6 +112,7 @@ export const apiKeySidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the API Key Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -114,6 +121,7 @@ export const apiKeySidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the API Key Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/apps/resources/sidebars/architectural-modules.mjs
+5 -5
View File
@@ -119,11 +119,6 @@ export const architecturalModulesSidebar = [
type: "sub-category",
title: "Guides",
children: [
{
type: "link",
path: "/architectural-modules/notification/send-notification",
title: "Send Notification",
},
{
type: "link",
path: "/references/notification-provider-module",
@@ -134,6 +129,11 @@ export const architecturalModulesSidebar = [
path: "/integrations/guides/resend",
title: "Integrate Resend",
},
{
type: "link",
path: "/architectural-modules/notification/send-notification",
title: "Send Notification",
},
],
},
],
www/apps/resources/sidebars/auth.mjs
+7
View File
@@ -51,6 +51,7 @@ export const authSidebar = [
autogenerate_tags: "server+auth",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Auth Module in your customizations on the Medusa application server.",
children: [
@@ -77,6 +78,7 @@ export const authSidebar = [
autogenerate_tags: "storefront+auth,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Auth Module's features into your storefront.",
},
@@ -86,6 +88,7 @@ export const authSidebar = [
autogenerate_tags: "admin+auth,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Auth Module.",
},
@@ -95,6 +98,7 @@ export const authSidebar = [
autogenerate_tags: "userGuide+auth",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Auth features in the Medusa Admin dashboard.",
},
@@ -138,12 +142,14 @@ export const authSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+auth",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+auth",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -154,6 +160,7 @@ export const authSidebar = [
hideChildren: true,
autogenerate_tags: "jsSdk+auth",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "link",
www/apps/resources/sidebars/cart.mjs
+8
View File
@@ -46,6 +46,7 @@ export const cartSidebar = [
autogenerate_tags: "server+cart",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Cart Module in your customizations on the Medusa application server.",
children: [
@@ -62,6 +63,7 @@ export const cartSidebar = [
autogenerate_tags: "storefront+cart,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Cart Module's features into your storefront.",
},
@@ -71,6 +73,7 @@ export const cartSidebar = [
autogenerate_tags: "admin+cart,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Cart Module.",
},
@@ -80,6 +83,7 @@ export const cartSidebar = [
autogenerate_tags: "userGuide+cart",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Cart features in the Medusa Admin dashboard.",
},
@@ -101,12 +105,14 @@ export const cartSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+cart",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+cart",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -123,6 +129,7 @@ export const cartSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Cart Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -131,6 +138,7 @@ export const cartSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Cart Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/apps/resources/sidebars/currency.mjs
+6
View File
@@ -31,6 +31,7 @@ export const currencySidebar = [
autogenerate_tags: "server+currency",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Currency Module in your customizations on the Medusa application server.",
},
@@ -40,6 +41,7 @@ export const currencySidebar = [
autogenerate_tags: "storefront+currency,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Currency Module's features into your storefront.",
},
@@ -49,6 +51,7 @@ export const currencySidebar = [
autogenerate_tags: "admin+currency,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Currency Module.",
},
@@ -58,6 +61,7 @@ export const currencySidebar = [
autogenerate_tags: "userGuide+currency",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Currency features in the Medusa Admin dashboard.",
},
@@ -81,6 +85,7 @@ export const currencySidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Currency Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -89,6 +94,7 @@ export const currencySidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Currency Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/apps/resources/sidebars/customer.mjs
+8
View File
@@ -36,6 +36,7 @@ export const customerSidebar = [
autogenerate_tags: "server+customer",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Customer Module in your customizations on the Medusa application server.",
children: [
@@ -52,6 +53,7 @@ export const customerSidebar = [
autogenerate_tags: "storefront+customer,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Customer Module's features into your storefront.",
},
@@ -61,6 +63,7 @@ export const customerSidebar = [
autogenerate_tags: "admin+customer,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Customer Module.",
},
@@ -70,6 +73,7 @@ export const customerSidebar = [
autogenerate_tags: "userGuide+customer",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Customer features in the Medusa Admin dashboard.",
},
@@ -91,12 +95,14 @@ export const customerSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+customer",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+customer",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -113,6 +119,7 @@ export const customerSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Customer Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -121,6 +128,7 @@ export const customerSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Customer Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/apps/resources/sidebars/examples.mjs
+3
View File
@@ -31,6 +31,7 @@ export const examplesSidebar = [
title: "Server Examples",
autogenerate_tags: "example+server",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
children: [
{
type: "link",
@@ -44,6 +45,7 @@ export const examplesSidebar = [
title: "Admin Examples",
autogenerate_tags: "example+admin",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
children: [],
},
{
@@ -51,6 +53,7 @@ export const examplesSidebar = [
title: "Storefront Examples",
autogenerate_tags: "example+storefront",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
children: [],
},
],
www/apps/resources/sidebars/fulfillment.mjs
+8
View File
@@ -58,6 +58,7 @@ export const fulfillmentSidebar = [
autogenerate_tags: "server+fulfillment",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Fulfillment Module in your customizations on the Medusa application server.",
children: [
@@ -79,6 +80,7 @@ export const fulfillmentSidebar = [
autogenerate_tags: "storefront+fulfillment,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Fulfillment Module's features into your storefront.",
},
@@ -88,6 +90,7 @@ export const fulfillmentSidebar = [
autogenerate_tags: "admin+fulfillment,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Fulfillment Module.",
},
@@ -97,6 +100,7 @@ export const fulfillmentSidebar = [
autogenerate_tags: "userGuide+fulfillment",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Fulfillment features in the Medusa Admin dashboard.",
},
@@ -118,12 +122,14 @@ export const fulfillmentSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+fulfillment",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+fulfillment",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -140,6 +146,7 @@ export const fulfillmentSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Fulfillment Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -148,6 +155,7 @@ export const fulfillmentSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Fulfillment Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/apps/resources/sidebars/inventory.mjs
+8
View File
@@ -48,6 +48,7 @@ export const inventorySidebar = [
autogenerate_tags: "server+inventory",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Inventory Module in your customizations on the Medusa application server.",
},
@@ -57,6 +58,7 @@ export const inventorySidebar = [
autogenerate_tags: "storefront+inventory,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Inventory Module's features into your storefront.",
},
@@ -66,6 +68,7 @@ export const inventorySidebar = [
autogenerate_tags: "admin+inventory,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Inventory Module.",
},
@@ -75,6 +78,7 @@ export const inventorySidebar = [
autogenerate_tags: "userGuide+inventory",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Inventory features in the Medusa Admin dashboard.",
},
@@ -96,12 +100,14 @@ export const inventorySidebar = [
title: "Workflows",
autogenerate_tags: "workflow+inventory",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+inventory",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -118,6 +124,7 @@ export const inventorySidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Inventory Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -126,6 +133,7 @@ export const inventorySidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Inventory Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/apps/resources/sidebars/order-module.mjs
+8
View File
@@ -81,6 +81,7 @@ export const orderSidebar = [
autogenerate_tags: "server+order",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Order Module in your customizations on the Medusa application server.",
},
@@ -90,6 +91,7 @@ export const orderSidebar = [
autogenerate_tags: "storefront+order,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Order Module's features into your storefront.",
},
@@ -99,6 +101,7 @@ export const orderSidebar = [
autogenerate_tags: "admin+order,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Order Module.",
},
@@ -108,6 +111,7 @@ export const orderSidebar = [
autogenerate_tags: "userGuide+order",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Order features in the Medusa Admin dashboard.",
},
@@ -129,12 +133,14 @@ export const orderSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+order",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+order",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -151,6 +157,7 @@ export const orderSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Order Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -159,6 +166,7 @@ export const orderSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Order Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/apps/resources/sidebars/payment.mjs
+8
View File
@@ -66,6 +66,7 @@ export const paymentSidebar = [
autogenerate_tags: "server+payment",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Payment Module in your customizations on the Medusa application server.",
children: [
@@ -87,6 +88,7 @@ export const paymentSidebar = [
autogenerate_tags: "storefront+payment,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Payment Module's features into your storefront.",
},
@@ -96,6 +98,7 @@ export const paymentSidebar = [
autogenerate_tags: "admin+payment,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Payment Module.",
},
@@ -105,6 +108,7 @@ export const paymentSidebar = [
autogenerate_tags: "userGuide+payment",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Payment features in the Medusa Admin dashboard.",
},
@@ -138,12 +142,14 @@ export const paymentSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+payment",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+payment",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -160,6 +166,7 @@ export const paymentSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Payment Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -168,6 +175,7 @@ export const paymentSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Payment Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/apps/resources/sidebars/pricing.mjs
+8
View File
@@ -51,6 +51,7 @@ export const pricingSidebar = [
autogenerate_tags: "server+pricing",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Pricing Module in your customizations on the Medusa application server.",
},
@@ -60,6 +61,7 @@ export const pricingSidebar = [
autogenerate_tags: "storefront+pricing,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Pricing Module's features into your storefront.",
},
@@ -69,6 +71,7 @@ export const pricingSidebar = [
autogenerate_tags: "admin+pricing,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Pricing Module.",
},
@@ -78,6 +81,7 @@ export const pricingSidebar = [
autogenerate_tags: "userGuide+pricing",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Pricing features in the Medusa Admin dashboard.",
},
@@ -99,12 +103,14 @@ export const pricingSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+pricing",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+pricing",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -121,6 +127,7 @@ export const pricingSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Pricing Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -129,6 +136,7 @@ export const pricingSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Pricing Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/apps/resources/sidebars/product.mjs
+8
View File
@@ -43,6 +43,7 @@ export const productSidebar = [
autogenerate_tags: "server+product",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Product Module in your customizations on the Medusa application server.",
children: [
@@ -69,6 +70,7 @@ export const productSidebar = [
autogenerate_tags: "storefront+product,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Product Module's features into your storefront.",
},
@@ -78,6 +80,7 @@ export const productSidebar = [
autogenerate_tags: "admin+product,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Product Module.",
},
@@ -87,6 +90,7 @@ export const productSidebar = [
autogenerate_tags: "userGuide+product",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Product features in the Medusa Admin dashboard.",
},
@@ -108,12 +112,14 @@ export const productSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+product",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+product",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -130,6 +136,7 @@ export const productSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Product Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -138,6 +145,7 @@ export const productSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Product Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/apps/resources/sidebars/promotion.mjs
+8
View File
@@ -51,6 +51,7 @@ export const promotionSidebar = [
autogenerate_tags: "server+promotion",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Promotion Module in your customizations on the Medusa application server.",
children: [
@@ -67,6 +68,7 @@ export const promotionSidebar = [
autogenerate_tags: "storefront+promotion,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Promotion Module's features into your storefront.",
},
@@ -76,6 +78,7 @@ export const promotionSidebar = [
autogenerate_tags: "admin+promotion,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Promotion Module.",
},
@@ -85,6 +88,7 @@ export const promotionSidebar = [
autogenerate_tags: "userGuide+promotion",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Promotion features in the Medusa Admin dashboard.",
},
@@ -106,12 +110,14 @@ export const promotionSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+promotion",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+promotion",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -128,6 +134,7 @@ export const promotionSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Promotion Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -136,6 +143,7 @@ export const promotionSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Promotion Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/apps/resources/sidebars/region.mjs
+8
View File
@@ -31,6 +31,7 @@ export const regionSidebar = [
autogenerate_tags: "server+region",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Region Module in your customizations on the Medusa application server.",
},
@@ -40,6 +41,7 @@ export const regionSidebar = [
autogenerate_tags: "storefront+region,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Region Module's features into your storefront.",
},
@@ -49,6 +51,7 @@ export const regionSidebar = [
autogenerate_tags: "admin+region,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Region Module.",
},
@@ -58,6 +61,7 @@ export const regionSidebar = [
autogenerate_tags: "userGuide+region",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Region features in the Medusa Admin dashboard.",
},
@@ -79,12 +83,14 @@ export const regionSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+region",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+region",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -101,6 +107,7 @@ export const regionSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Region Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -109,6 +116,7 @@ export const regionSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Region Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/apps/resources/sidebars/sales-channel.mjs
+8
View File
@@ -38,6 +38,7 @@ export const salesChannelSidebar = [
autogenerate_tags: "server+salesChannel",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Sales Channel Module in your customizations on the Medusa application server.",
},
@@ -47,6 +48,7 @@ export const salesChannelSidebar = [
autogenerate_tags: "storefront+salesChannel,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Sales Channel Module's features into your storefront.",
},
@@ -56,6 +58,7 @@ export const salesChannelSidebar = [
autogenerate_tags: "admin+salesChannel,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Sales Channel Module.",
},
@@ -65,6 +68,7 @@ export const salesChannelSidebar = [
autogenerate_tags: "userGuide+salesChannel",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Sales Channel features in the Medusa Admin dashboard.",
},
@@ -86,12 +90,14 @@ export const salesChannelSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+salesChannel",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+salesChannel",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -108,6 +114,7 @@ export const salesChannelSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Sales Channel Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -116,6 +123,7 @@ export const salesChannelSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Sales Channel Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/apps/resources/sidebars/stock-location.mjs
+8
View File
@@ -38,6 +38,7 @@ export const stockLocationSidebar = [
autogenerate_tags: "server+stockLocation",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Stock Location Module in your customizations on the Medusa application server.",
},
@@ -47,6 +48,7 @@ export const stockLocationSidebar = [
autogenerate_tags: "storefront+stockLocation,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Stock Location Module's features into your storefront.",
},
@@ -56,6 +58,7 @@ export const stockLocationSidebar = [
autogenerate_tags: "admin+stockLocation,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Stock Location Module.",
},
@@ -65,6 +68,7 @@ export const stockLocationSidebar = [
autogenerate_tags: "userGuide+stockLocation",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Stock Location features in the Medusa Admin dashboard.",
},
@@ -86,12 +90,14 @@ export const stockLocationSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+stockLocation",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+stockLocation",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -108,6 +114,7 @@ export const stockLocationSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Stock Location Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -116,6 +123,7 @@ export const stockLocationSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Stock Location Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/apps/resources/sidebars/store.mjs
+8
View File
@@ -31,6 +31,7 @@ export const storeSidebar = [
autogenerate_tags: "server+store",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Store Module in your customizations on the Medusa application server.",
},
@@ -40,6 +41,7 @@ export const storeSidebar = [
autogenerate_tags: "storefront+store,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Store Module's features into your storefront.",
},
@@ -49,6 +51,7 @@ export const storeSidebar = [
autogenerate_tags: "admin+store,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Store Module.",
},
@@ -58,6 +61,7 @@ export const storeSidebar = [
autogenerate_tags: "userGuide+store",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Store features in the Medusa Admin dashboard.",
},
@@ -79,12 +83,14 @@ export const storeSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+store",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+store",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -101,6 +107,7 @@ export const storeSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Store Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -109,6 +116,7 @@ export const storeSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Store Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/apps/resources/sidebars/tax.mjs
+8
View File
@@ -46,6 +46,7 @@ export const taxSidebar = [
autogenerate_tags: "server+tax",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Tax Module in your customizations on the Medusa application server.",
children: [
@@ -62,6 +63,7 @@ export const taxSidebar = [
autogenerate_tags: "storefront+tax,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Tax Module's features into your storefront.",
},
@@ -71,6 +73,7 @@ export const taxSidebar = [
autogenerate_tags: "admin+tax,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Tax Module.",
},
@@ -80,6 +83,7 @@ export const taxSidebar = [
autogenerate_tags: "userGuide+tax",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Tax features in the Medusa Admin dashboard.",
},
@@ -101,12 +105,14 @@ export const taxSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+tax",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+tax",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -123,6 +129,7 @@ export const taxSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Tax Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -131,6 +138,7 @@ export const taxSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Tax Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/apps/resources/sidebars/user.mjs
+8
View File
@@ -24,6 +24,7 @@ export const userSidebar = [
autogenerate_tags: "server+user",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the User Module in your customizations on the Medusa application server.",
children: [
@@ -40,6 +41,7 @@ export const userSidebar = [
autogenerate_tags: "storefront+user,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the User Module's features into your storefront.",
},
@@ -49,6 +51,7 @@ export const userSidebar = [
autogenerate_tags: "admin+user,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the User Module.",
},
@@ -58,6 +61,7 @@ export const userSidebar = [
autogenerate_tags: "userGuide+user",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage User features in the Medusa Admin dashboard.",
},
@@ -79,12 +83,14 @@ export const userSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+user",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+user",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -101,6 +107,7 @@ export const userSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the User Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -109,6 +116,7 @@ export const userSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the User Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
www/packages/build-scripts/src/generate-sidebar.ts
+6
View File
@@ -5,6 +5,7 @@ import { getSidebarItemLink, sidebarAttachHrefCommonOptions } from "./index.js"
import getCoreFlowsRefSidebarChildren from "./utils/get-core-flows-ref-sidebar-children.js"
import { parseTags } from "./utils/parse-tags.js"
import numberSidebarItems from "./utils/number-sidebar-items.js"
import { sortSidebarItems } from "./utils/sidebar-sorting.js"
export type ItemsToAdd = SidebarItem & {
sidebar_position?: number
@@ -160,6 +161,11 @@ async function checkItem(item: RawSidebarItem): Promise<RawSidebarItem> {
item.children = await checkItems(item.children)
}
item.children = sortSidebarItems({
items: item.children as RawSidebarItem[],
type: item.sort_sidebar,
})
return item
}
www/packages/build-scripts/src/utils/sidebar-sorting.ts
+49
View File
@@ -0,0 +1,49 @@
import { InteractiveSidebarItem, RawSidebarItem, SidebarSortType } from "types"
type Options = {
items: RawSidebarItem[]
type?: SidebarSortType
}
export const sortSidebarItems = ({
items,
type = "none",
}: Options): RawSidebarItem[] => {
switch (type) {
case "alphabetize":
return alphabetizeSidebarItems(items)
default:
return items
}
}
const alphabetizeSidebarItems = (items: RawSidebarItem[]): RawSidebarItem[] => {
const segments: RawSidebarItem[][] = []
let currentSegment: RawSidebarItem[] = []
items.forEach((item) => {
if (item.type === "separator") {
if (currentSegment.length > 0) {
segments.push(currentSegment)
currentSegment = []
}
segments.push([item])
} else {
currentSegment.push(item)
}
})
if (currentSegment.length > 0) {
segments.push(currentSegment)
}
return segments
.map((segment) => {
return segment[0].type === "separator"
? segment
: (segment as InteractiveSidebarItem[]).sort((a, b) =>
a.title.localeCompare(b.title)
)
})
.flat()
}
www/packages/tags/src/tags/index.ts
+21 -21
View File
@@ -1,40 +1,40 @@
export * from "./user-guide.js"
export * from "./order.js"
export * from "./fulfillment.js"
export * from "./payment.js"
export * from "./pricing.js"
export * from "./product.js"
export * from "./promotion.js"
export * from "./user.js"
export * from "./auth.js"
export * from "./product.js"
export * from "./api-key.js"
export * from "./stock-location.js"
export * from "./workflow.js"
export * from "./region.js"
export * from "./stock-location.js"
export * from "./sales-channel.js"
export * from "./currency.js"
export * from "./tax.js"
export * from "./region.js"
export * from "./store.js"
export * from "./currency.js"
export * from "./concept.js"
export * from "./tax.js"
export * from "./query.js"
export * from "./order.js"
export * from "./inventory.js"
export * from "./cart.js"
export * from "./customer.js"
export * from "./fulfillment.js"
export * from "./product-category.js"
export * from "./stripe.js"
export * from "./customer.js"
export * from "./checkout.js"
export * from "./server.js"
export * from "./publishable-api-key.js"
export * from "./product-collection.js"
export * from "./js-sdk.js"
export * from "./logger.js"
export * from "./step.js"
export * from "./remote-query.js"
export * from "./example.js"
export * from "./product-collection.js"
export * from "./publishable-api-key.js"
export * from "./link.js"
export * from "./step.js"
export * from "./product-category.js"
export * from "./locking.js"
export * from "./event-bus.js"
export * from "./remote-query.js"
export * from "./logger.js"
export * from "./js-sdk.js"
export * from "./file.js"
export * from "./admin.js"
export * from "./notification.js"
export * from "./event-bus.js"
export * from "./file.js"
export * from "./link.js"
export * from "./cart.js"
export * from "./storefront.js"
export * from "./locking.js"
export * from "./server.js"
www/packages/tags/src/tags/js-sdk.ts
-4
View File
@@ -1,8 +1,4 @@
export const jsSdk = [
{
"title": "Implement Express Checkout with Medusa",
"path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout"
},
{
"title": "apiKey",
"path": "https://docs.medusajs.com/resources/references/js-sdk/admin/apiKey"
www/packages/types/src/sidebar.ts
+3
View File
@@ -67,10 +67,13 @@ export type SidebarSectionItems = {
parentItem?: InteractiveSidebarItem
}
export type SidebarSortType = "none" | "alphabetize"
export type RawSidebarItem = SidebarItem & {
autogenerate_path?: string
autogenerate_tags?: string
autogenerate_as_ref?: boolean
sort_sidebar?: SidebarSortType
custom_autogenerate?: string
number?: string
} & (