diff --git a/www/apps/api-reference/providers/base-specs.tsx b/www/apps/api-reference/providers/base-specs.tsx index ff7363987b..da66b3c919 100644 --- a/www/apps/api-reference/providers/base-specs.tsx +++ b/www/apps/api-reference/providers/base-specs.tsx @@ -68,7 +68,6 @@ const BaseSpecsProvider = ({ children, baseSpecs }: BaseSpecsProviderProps) => { children: childItems, loaded: childItems.length > 0, showLoadingIfEmpty: true, - initialOpen: false, onOpen: () => { if (location.hash !== tagPathName) { router.push(`#${tagPathName}`, { diff --git a/www/apps/resources/app/architectural-modules/cache/create/page.mdx b/www/apps/resources/app/architectural-modules/cache/create/page.mdx index 97a0f639ca..45d110ae1e 100644 --- a/www/apps/resources/app/architectural-modules/cache/create/page.mdx +++ b/www/apps/resources/app/architectural-modules/cache/create/page.mdx @@ -1,3 +1,11 @@ +--- +sidebar_label: "Create Cache Module" +tags: + - cache + - how to + - server +--- + export const metadata = { title: `How to Create a Cache Module`, } diff --git a/www/apps/resources/app/architectural-modules/event/create/page.mdx b/www/apps/resources/app/architectural-modules/event/create/page.mdx index 5c0f75cb76..ff216bf82e 100644 --- a/www/apps/resources/app/architectural-modules/event/create/page.mdx +++ b/www/apps/resources/app/architectural-modules/event/create/page.mdx @@ -1,3 +1,11 @@ +--- +sidebar_label: "Create Event Module" +tags: + - event + - how to + - server +--- + import { TypeList } from "docs-ui" export const metadata = { diff --git a/www/apps/resources/app/architectural-modules/notification/send-notification/page.mdx b/www/apps/resources/app/architectural-modules/notification/send-notification/page.mdx index 84157b8461..ad81c85545 100644 --- a/www/apps/resources/app/architectural-modules/notification/send-notification/page.mdx +++ b/www/apps/resources/app/architectural-modules/notification/send-notification/page.mdx @@ -1,3 +1,11 @@ +--- +sidebar_label: "Send Notification" +tags: + - notification + - how to + - server +--- + import { TypeList } from "docs-ui" export const metadata = { diff --git a/www/apps/resources/app/commerce-modules/auth/create-actor-type/page.mdx b/www/apps/resources/app/commerce-modules/auth/create-actor-type/page.mdx index ef99fc17af..193c5f2556 100644 --- a/www/apps/resources/app/commerce-modules/auth/create-actor-type/page.mdx +++ b/www/apps/resources/app/commerce-modules/auth/create-actor-type/page.mdx @@ -1,3 +1,11 @@ +--- +sidebar_label: "Create Actor Type" +tags: + - auth + - how to + - server +--- + export const metadata = { title: `How to Create an Actor Type`, } diff --git a/www/apps/resources/app/commerce-modules/auth/reset-password/page.mdx b/www/apps/resources/app/commerce-modules/auth/reset-password/page.mdx index 39162cb988..bdfb553154 100644 --- a/www/apps/resources/app/commerce-modules/auth/reset-password/page.mdx +++ b/www/apps/resources/app/commerce-modules/auth/reset-password/page.mdx @@ -1,3 +1,11 @@ +--- +sidebar_label: "Handle Password Reset Event" +tags: + - notification + - how to + - server +--- + import { Prerequisites } from "docs-ui" export const metadata = { diff --git a/www/apps/resources/app/commerce-modules/cart/extend/page.mdx b/www/apps/resources/app/commerce-modules/cart/extend/page.mdx index d4520101f8..6d1e7ca2eb 100644 --- a/www/apps/resources/app/commerce-modules/cart/extend/page.mdx +++ b/www/apps/resources/app/commerce-modules/cart/extend/page.mdx @@ -1,3 +1,12 @@ +--- +sidebar_label: "Extend Cart" +tags: + - cart + - tutorial + - extend module + - server +--- + import { Prerequisites } from "docs-ui" export const metadata = { diff --git a/www/apps/resources/app/commerce-modules/customer/extend/page.mdx b/www/apps/resources/app/commerce-modules/customer/extend/page.mdx index 74298d4097..fe005b2098 100644 --- a/www/apps/resources/app/commerce-modules/customer/extend/page.mdx +++ b/www/apps/resources/app/commerce-modules/customer/extend/page.mdx @@ -1,3 +1,12 @@ +--- +sidebar_label: "Extend Customer" +tags: + - customer + - tutorial + - extend module + - server +--- + import { Prerequisites } from "docs-ui" export const metadata = { diff --git a/www/apps/resources/app/commerce-modules/product/extend/page.mdx b/www/apps/resources/app/commerce-modules/product/extend/page.mdx index dc0e241ac5..2b002959d6 100644 --- a/www/apps/resources/app/commerce-modules/product/extend/page.mdx +++ b/www/apps/resources/app/commerce-modules/product/extend/page.mdx @@ -1,3 +1,12 @@ +--- +sidebar_label: "Extend Product" +tags: + - product + - tutorial + - extend module + - server +--- + import { Prerequisites } from "docs-ui" export const metadata = { diff --git a/www/apps/resources/app/commerce-modules/product/guides/price-with-taxes/page.mdx b/www/apps/resources/app/commerce-modules/product/guides/price-with-taxes/page.mdx index 7e405cabee..c05ab06870 100644 --- a/www/apps/resources/app/commerce-modules/product/guides/price-with-taxes/page.mdx +++ b/www/apps/resources/app/commerce-modules/product/guides/price-with-taxes/page.mdx @@ -6,6 +6,7 @@ tags: - query - tax - server + - how to --- export const metadata = { diff --git a/www/apps/resources/app/commerce-modules/product/guides/price/page.mdx b/www/apps/resources/app/commerce-modules/product/guides/price/page.mdx index afc633b2cd..1b5b08be02 100644 --- a/www/apps/resources/app/commerce-modules/product/guides/price/page.mdx +++ b/www/apps/resources/app/commerce-modules/product/guides/price/page.mdx @@ -5,6 +5,7 @@ tags: - pricing - query - server + - how to --- export const metadata = { diff --git a/www/apps/resources/app/commerce-modules/promotion/extend/page.mdx b/www/apps/resources/app/commerce-modules/promotion/extend/page.mdx index 2b0e8bf2d6..8fad32c9a5 100644 --- a/www/apps/resources/app/commerce-modules/promotion/extend/page.mdx +++ b/www/apps/resources/app/commerce-modules/promotion/extend/page.mdx @@ -1,3 +1,12 @@ +--- +sidebar_label: "Extend Promotion" +tags: + - promotion + - tutorial + - extend module + - server +--- + import { Prerequisites } from "docs-ui" export const metadata = { diff --git a/www/apps/resources/app/examples/guides/custom-item-price/page.mdx b/www/apps/resources/app/examples/guides/custom-item-price/page.mdx index 660bc9f144..21158b5286 100644 --- a/www/apps/resources/app/examples/guides/custom-item-price/page.mdx +++ b/www/apps/resources/app/examples/guides/custom-item-price/page.mdx @@ -4,6 +4,7 @@ tags: - cart - pricing - server + - tutorial --- import { Github, PlaySolid } from "@medusajs/icons" diff --git a/www/apps/resources/app/examples/guides/quote-management/page.mdx b/www/apps/resources/app/examples/guides/quote-management/page.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/www/apps/resources/app/plugins/guides/wishlist/page.mdx b/www/apps/resources/app/plugins/guides/wishlist/page.mdx index 56bd1f2530..b24871efb1 100644 --- a/www/apps/resources/app/plugins/guides/wishlist/page.mdx +++ b/www/apps/resources/app/plugins/guides/wishlist/page.mdx @@ -1,3 +1,11 @@ +--- +sidebar_label: "Build Wishlist Plugin" +tags: + - product + - tutorial + - server +--- + import { Github, PlaySolid } from "@medusajs/icons" import { Prerequisites, CardList, WorkflowDiagram } from "docs-ui" diff --git a/www/apps/resources/generated/sidebar.mjs b/www/apps/resources/generated/sidebar.mjs index 6da6ecf758..451e2be53d 100644 --- a/www/apps/resources/generated/sidebar.mjs +++ b/www/apps/resources/generated/sidebar.mjs @@ -18,14 +18,6 @@ export const generatedSidebars = [ "sidebar_id": "examples", "title": "Examples", "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/examples", - "title": "Example Snippets", - "children": [] - }, { "loaded": true, "isPathHref": true, @@ -71,175 +63,6 @@ export const generatedSidebars = [ } ] }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "recipes", - "title": "Recipes", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/marketplace", - "title": "Marketplace", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/marketplace/examples/vendors", - "title": "Example: Vendors", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/marketplace/examples/restaurant-delivery", - "title": "Example: Restaurant-Delivery", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/subscriptions", - "title": "Subscriptions", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/subscriptions/examples/standard", - "title": "Example", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/digital-products", - "title": "Digital Products", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/digital-products/examples/standard", - "title": "Example", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/erp", - "title": "Integrate ERP", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/erp/odoo", - "title": "Example: Odoo Integration", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/b2b", - "title": "B2B", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/commerce-automation", - "title": "Commerce Automation", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/commerce-automation/restock-notification", - "title": "Example: Restock Notifications", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/ecommerce", - "title": "Ecommerce", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/multi-region-store", - "title": "Multi-Region Store", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/omnichannel", - "title": "Omnichannel Store", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/oms", - "title": "OMS", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/personalized-products", - "title": "Personalized Products", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/pos", - "title": "POS", - "children": [] - } - ] - }, { "type": "separator" }, @@ -275,7 +98,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Concepts", - "initialOpen": false, "children": [ { "loaded": true, @@ -295,12 +117,39 @@ export const generatedSidebars = [ } ] }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+auth", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the API Key Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Actor Type", + "path": "https://docs.medusajs.com/resources/commerce-modules/auth/create-actor-type", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Auth Provider", + "path": "https://docs.medusajs.com/resources/references/auth/provider", + "children": [] + } + ] + }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Storefront Guides", - "initialOpen": false, "autogenerate_tags": "storefront+apiKey,-jsSdk", "autogenerate_as_ref": true, "sort_sidebar": "alphabetize", @@ -321,7 +170,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Admin User Guides", - "initialOpen": false, "autogenerate_tags": "userGuide+apiKey", "autogenerate_as_ref": true, "sort_sidebar": "alphabetize", @@ -350,7 +198,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the API Key Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -674,7 +521,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Concepts", - "initialOpen": false, "children": [ { "loaded": true, @@ -716,11 +562,18 @@ export const generatedSidebars = [ "type": "category", "title": "Server Guides", "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": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Actor Type", + "path": "https://docs.medusajs.com/resources/commerce-modules/auth/create-actor-type", + "children": [] + }, { "loaded": true, "isPathHref": true, @@ -729,6 +582,14 @@ export const generatedSidebars = [ "title": "Create an Actor Type", "children": [] }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Auth Provider", + "path": "https://docs.medusajs.com/resources/references/auth/provider", + "children": [] + }, { "loaded": true, "isPathHref": true, @@ -753,7 +614,6 @@ export const generatedSidebars = [ "type": "category", "title": "Storefront Guides", "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.", @@ -814,7 +674,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin User Guides", "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.", @@ -834,7 +693,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Providers", - "initialOpen": false, "children": [ { "loaded": true, @@ -867,7 +725,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the Auth Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -1275,7 +1132,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Concepts", - "initialOpen": false, "children": [ { "loaded": true, @@ -1317,11 +1173,18 @@ export const generatedSidebars = [ "type": "category", "title": "Server Guides", "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": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Extend Cart", + "path": "https://docs.medusajs.com/resources/commerce-modules/cart/extend", + "children": [] + }, { "loaded": true, "isPathHref": true, @@ -1346,7 +1209,6 @@ export const generatedSidebars = [ "type": "category", "title": "Storefront Guides", "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.", @@ -1454,7 +1316,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the Cart Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -2370,7 +2231,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "sub-category", "title": "Concepts", - "initialOpen": false, "children": [ { "loaded": true, @@ -2388,7 +2248,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin User Guides", "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.", @@ -2408,7 +2267,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "sub-category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the Currency Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -2564,7 +2422,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Concepts", - "initialOpen": false, "children": [ { "loaded": true, @@ -2590,11 +2447,18 @@ export const generatedSidebars = [ "type": "category", "title": "Server Guides", "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": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Extend Customer", + "path": "https://docs.medusajs.com/resources/commerce-modules/customer/extend", + "children": [] + }, { "loaded": true, "isPathHref": true, @@ -2611,7 +2475,6 @@ export const generatedSidebars = [ "type": "category", "title": "Storefront Guides", "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.", @@ -2696,7 +2559,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin User Guides", "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.", @@ -2732,7 +2594,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the Customer Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -3468,7 +3329,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Concepts", - "initialOpen": false, "autogenerate_tags": "concept+fulfillment", "autogenerate_as_ref": true, "children": [ @@ -3528,11 +3388,18 @@ export const generatedSidebars = [ "type": "category", "title": "Server Guides", "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": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Fulfillment Provider", + "path": "https://docs.medusajs.com/resources/references/fulfillment/provider", + "children": [] + }, { "loaded": true, "isPathHref": true, @@ -3557,7 +3424,6 @@ export const generatedSidebars = [ "type": "category", "title": "Storefront Guides", "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.", @@ -3586,7 +3452,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin User Guides", "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.", @@ -3622,7 +3487,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the Fulfillment Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -5052,7 +4916,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Concepts", - "initialOpen": false, "autogenerate_tags": "concept+inventory", "autogenerate_as_ref": true, "children": [ @@ -5112,7 +4975,6 @@ export const generatedSidebars = [ "type": "category", "title": "Storefront Guides", "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.", @@ -5133,7 +4995,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin User Guides", "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.", @@ -5169,7 +5030,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the Inventory Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -6063,7 +5923,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Concepts", - "initialOpen": false, "children": [ { "loaded": true, @@ -6161,7 +6020,6 @@ export const generatedSidebars = [ "type": "category", "title": "Storefront Guides", "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.", @@ -6190,7 +6048,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin User Guides", "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.", @@ -6274,7 +6131,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the Order Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -8942,7 +8798,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Concepts", - "initialOpen": false, "children": [ { "loaded": true, @@ -9008,7 +8863,6 @@ export const generatedSidebars = [ "type": "category", "title": "Server Guides", "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.", @@ -9028,6 +8882,14 @@ export const generatedSidebars = [ "path": "/references/payment/provider", "title": "Create Payment Provider", "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Payment Provider", + "path": "https://docs.medusajs.com/resources/references/payment/provider", + "children": [] } ] }, @@ -9037,7 +8899,6 @@ export const generatedSidebars = [ "type": "category", "title": "Storefront Guides", "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.", @@ -9090,7 +8951,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin User Guides", "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.", @@ -9110,7 +8970,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Providers", - "initialOpen": false, "children": [ { "loaded": true, @@ -9127,7 +8986,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the Payment Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -10107,7 +9965,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Concepts", - "initialOpen": false, "children": [ { "loaded": true, @@ -10157,7 +10014,6 @@ export const generatedSidebars = [ "type": "category", "title": "Server Guides", "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.", @@ -10194,7 +10050,6 @@ export const generatedSidebars = [ "type": "category", "title": "Storefront Guides", "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.", @@ -10239,7 +10094,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin User Guides", "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.", @@ -10275,7 +10129,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the Pricing Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -11198,7 +11051,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Concepts", - "initialOpen": false, "autogenerate_tags": "concept+product", "autogenerate_as_ref": true, "children": [ @@ -11242,11 +11094,18 @@ export const generatedSidebars = [ "type": "category", "title": "Server Guides", "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": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Build Wishlist Plugin", + "path": "https://docs.medusajs.com/resources/plugins/guides/wishlist", + "children": [] + }, { "loaded": true, "isPathHref": true, @@ -11255,6 +11114,14 @@ export const generatedSidebars = [ "title": "Extend Module", "children": [] }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Extend Product", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/extend", + "children": [] + }, { "loaded": true, "isPathHref": true, @@ -11295,7 +11162,6 @@ export const generatedSidebars = [ "type": "category", "title": "Storefront Guides", "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.", @@ -11436,7 +11302,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin User Guides", "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.", @@ -11544,7 +11409,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the Product Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -12916,7 +12780,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Concepts", - "initialOpen": false, "children": [ { "loaded": true, @@ -12966,7 +12829,6 @@ export const generatedSidebars = [ "type": "category", "title": "Server Guides", "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.", @@ -12978,6 +12840,14 @@ export const generatedSidebars = [ "path": "/commerce-modules/promotion/extend", "title": "Extend Module", "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Extend Promotion", + "path": "https://docs.medusajs.com/resources/commerce-modules/promotion/extend", + "children": [] } ] }, @@ -12987,7 +12857,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin User Guides", "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.", @@ -13031,7 +12900,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the Promotion Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -13804,7 +13672,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Concepts", - "initialOpen": false, "children": [ { "loaded": true, @@ -13822,7 +13689,6 @@ export const generatedSidebars = [ "type": "category", "title": "Storefront Guides", "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.", @@ -13867,7 +13733,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin User Guides", "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.", @@ -13887,7 +13752,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the Region Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -14361,7 +14225,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Concepts", - "initialOpen": false, "autogenerate_tags": "concept+salesChannel", "autogenerate_as_ref": true, "children": [ @@ -14397,7 +14260,6 @@ export const generatedSidebars = [ "type": "category", "title": "Storefront Guides", "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.", @@ -14418,7 +14280,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin User Guides", "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.", @@ -14438,7 +14299,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the Sales Channel Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -14853,7 +14713,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Concepts", - "initialOpen": false, "autogenerate_tags": "concept+stockLocation", "autogenerate_as_ref": true, "children": [ @@ -14897,7 +14756,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin User Guides", "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.", @@ -14925,7 +14783,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the Stock Location Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -15259,7 +15116,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Concepts", - "initialOpen": false, "children": [ { "loaded": true, @@ -15277,7 +15133,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin User Guides", "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.", @@ -15297,7 +15152,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the Store Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -15700,7 +15554,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "Concepts", - "initialOpen": false, "children": [ { "loaded": true, @@ -15734,11 +15587,18 @@ export const generatedSidebars = [ "type": "category", "title": "Server Guides", "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": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Tax Provider", + "path": "https://docs.medusajs.com/resources/references/tax/provider", + "children": [] + }, { "loaded": true, "isPathHref": true, @@ -15763,7 +15623,6 @@ export const generatedSidebars = [ "type": "category", "title": "Storefront Guides", "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.", @@ -15784,7 +15643,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin User Guides", "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.", @@ -15804,7 +15662,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the Tax Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -16502,7 +16359,6 @@ export const generatedSidebars = [ "type": "category", "title": "Server Guides", "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.", @@ -16523,7 +16379,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin User Guides", "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.", @@ -16567,7 +16422,6 @@ export const generatedSidebars = [ "isPathHref": true, "type": "category", "title": "References", - "initialOpen": false, "description": "Find references for tools and resources related to the User Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { @@ -17437,23 +17291,6 @@ export const generatedSidebars = [ "title": "Overview", "path": "/plugins", "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Guides", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Wishlist", - "path": "/plugins/guides/wishlist", - "description": "Learn how to build a wishlist plugin.", - "children": [] - } - ] } ] }, @@ -18061,7 +17898,6 @@ export const generatedSidebars = [ "type": "category", "title": "Auth", "autogenerate_path": "/references/js_sdk/auth/Auth/methods", - "initialOpen": true, "children": [ { "loaded": true, @@ -18134,7 +17970,6 @@ export const generatedSidebars = [ "type": "category", "title": "Store", "autogenerate_path": "/references/js_sdk/store/Store/properties", - "initialOpen": true, "children": [ { "loaded": true, @@ -18225,7 +18060,6 @@ export const generatedSidebars = [ "type": "category", "title": "Admin", "autogenerate_path": "/references/js_sdk/admin/Admin/properties", - "initialOpen": true, "children": [ { "loaded": true, @@ -18650,79 +18484,6 @@ export const generatedSidebars = [ "type": "category", "title": "General", "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "deployment-guides", - "title": "Deployment Guides", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/deployment", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Medusa Cloud", - "path": "https://medusajs.com/pricing", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Self-Hosting", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "https://docs.medusajs.com/learn/deployment/general", - "title": "General", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/deployment/medusa-application/railway", - "title": "Railway", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Next.js Starter", - "autogenerate_path": "/deployment/storefront", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/deployment/storefront/vercel", - "title": "Vercel", - "description": "", - "children": [] - } - ] - } - ] - }, { "loaded": true, "isPathHref": true, @@ -18903,134 +18664,6 @@ export const generatedSidebars = [ "path": "/admin-widget-injection-zones", "title": "Admin Widget Injection Zones", "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "admin-components", - "title": "Admin Components", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Layouts", - "autogenerate_path": "/admin-components/layouts", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/layouts/single-column", - "title": "Single Column", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/layouts/two-column", - "title": "Two Column", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Components", - "autogenerate_path": "/admin-components/components", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/components/action-menu", - "title": "Action Menu", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/components/container", - "title": "Container", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/components/data-table", - "title": "Data Table", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/components/forms", - "title": "Forms", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/components/header", - "title": "Header", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/components/json-view-section", - "title": "JSON View", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/components/section-row", - "title": "Section Row", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/components/table", - "title": "Table", - "description": "", - "children": [] - } - ] - } - ] } ] }, @@ -19756,8 +19389,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -19799,8 +19431,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -20301,8 +19932,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -20434,8 +20064,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -20612,8 +20241,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -20727,8 +20355,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -20770,8 +20397,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -20831,8 +20457,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -21216,8 +20841,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -21421,8 +21045,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -21518,8 +21141,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -21579,8 +21201,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -21614,8 +21235,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -23376,8 +22996,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -23500,8 +23119,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -23642,8 +23260,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -23811,8 +23428,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -23917,8 +23533,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -24428,8 +24043,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -24507,8 +24121,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -24748,8 +24361,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -24836,8 +24448,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -24933,8 +24544,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -25012,8 +24622,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -25154,8 +24763,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -25180,8 +24788,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -25232,8 +24839,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -25329,8 +24935,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -25408,8 +25013,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -25622,8 +25226,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] }, { "loaded": true, @@ -25719,8 +25322,7 @@ export const generatedSidebars = [ } ] } - ], - "initialOpen": false + ] } ] }, @@ -25771,5 +25373,489 @@ export const generatedSidebars = [ ] } ] + }, + { + "sidebar_id": "recipes", + "title": "Recipes", + "items": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/marketplace", + "title": "Marketplace", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/marketplace/examples/vendors", + "title": "Example: Vendors", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/marketplace/examples/restaurant-delivery", + "title": "Example: Restaurant-Delivery", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/subscriptions", + "title": "Subscriptions", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/subscriptions/examples/standard", + "title": "Example", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/digital-products", + "title": "Digital Products", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/digital-products/examples/standard", + "title": "Example", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/erp", + "title": "Integrate ERP", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/erp/odoo", + "title": "Example: Odoo Integration", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/b2b", + "title": "B2B", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/commerce-automation", + "title": "Commerce Automation", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/commerce-automation/restock-notification", + "title": "Example: Restock Notifications", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/ecommerce", + "title": "Ecommerce", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/multi-region-store", + "title": "Multi-Region Store", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/omnichannel", + "title": "Omnichannel Store", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/oms", + "title": "OMS", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/personalized-products", + "title": "Personalized Products", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/pos", + "title": "POS", + "children": [] + } + ] + }, + { + "sidebar_id": "how-to-tutorials", + "title": "How-To & Tutorials", + "items": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/how-to-tutorials", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/examples", + "title": "Example Snippets", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "How-To Guides", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Server", + "autogenerate_tags": "howTo+server", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Actor Type", + "path": "https://docs.medusajs.com/resources/commerce-modules/auth/create-actor-type", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Auth Provider", + "path": "https://docs.medusajs.com/resources/references/auth/provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Cache Module", + "path": "https://docs.medusajs.com/resources/architectural-modules/cache/create", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Event Module", + "path": "https://docs.medusajs.com/resources/architectural-modules/event/create", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Fulfillment Provider", + "path": "https://docs.medusajs.com/resources/references/fulfillment/provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Notification Provider", + "path": "https://docs.medusajs.com/resources/references/notification-provider-module", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Payment Provider", + "path": "https://docs.medusajs.com/resources/references/payment/provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Tax Provider", + "path": "https://docs.medusajs.com/resources/references/tax/provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Get Variant Price with Taxes", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Get Variant Prices", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Handle Password Reset Event", + "path": "https://docs.medusajs.com/resources/commerce-modules/auth/reset-password", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Send Notification", + "path": "https://docs.medusajs.com/resources/architectural-modules/notification/send-notification", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "howTo+admin", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/admin-components", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Components", + "autogenerate_path": "/admin-components/components", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Layouts", + "autogenerate_path": "/admin-components/layouts", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Tutorials", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Custom Item Pricing", + "path": "/examples/guides/custom-item-price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Wishlist", + "path": "/plugins/guides/wishlist", + "description": "Learn how to build a wishlist plugin.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Extend Modules", + "autogenerate_tags": "tutorial+extendModule", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Extend Cart", + "path": "https://docs.medusajs.com/resources/commerce-modules/cart/extend", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Extend Customer", + "path": "https://docs.medusajs.com/resources/commerce-modules/customer/extend", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Extend Product", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/extend", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Extend Promotion", + "path": "https://docs.medusajs.com/resources/commerce-modules/promotion/extend", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Deployment", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/deployment", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Medusa Cloud", + "path": "https://medusajs.com/pricing", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Self-Hosting", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "https://docs.medusajs.com/learn/deployment/general", + "title": "General", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/deployment/medusa-application/railway", + "title": "Railway", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Next.js Starter", + "autogenerate_path": "/deployment/storefront", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/deployment/storefront/vercel", + "title": "Vercel", + "description": "", + "children": [] + } + ] + } + ] + } + ] } ] \ No newline at end of file diff --git a/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx b/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx index f7e6284594..b3e443e0f9 100644 --- a/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx +++ b/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx @@ -1,5 +1,10 @@ --- slug: /references/auth/provider +tags: + - auth + - server + - how to +sidebar_label: Create Auth Provider --- import { TypeList } from "docs-ui" diff --git a/www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx b/www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx index 246c985446..161e76bb12 100644 --- a/www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx +++ b/www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx @@ -1,5 +1,10 @@ --- slug: /references/fulfillment/provider +tags: + - fulfillment + - server + - how to +sidebar_label: Create Fulfillment Provider --- import { TypeList } from "docs-ui" diff --git a/www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx b/www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx index d614ba3937..a4ee7a9856 100644 --- a/www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx +++ b/www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx @@ -1,5 +1,10 @@ --- slug: /references/notification-provider-module +tags: + - notification + - server + - how to +sidebar_label: Create Notification Provider --- import { TypeList } from "docs-ui" diff --git a/www/apps/resources/references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx b/www/apps/resources/references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx index 89510e7def..1fc77f1ff2 100644 --- a/www/apps/resources/references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx +++ b/www/apps/resources/references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx @@ -1,5 +1,10 @@ --- slug: /references/payment/provider +tags: + - payment + - server + - how to +sidebar_label: Create Payment Provider --- import { TypeList } from "docs-ui" diff --git a/www/apps/resources/references/tax_provider/interfaces/tax_provider.ITaxProvider/page.mdx b/www/apps/resources/references/tax_provider/interfaces/tax_provider.ITaxProvider/page.mdx index ebe60da903..5d8fac5df9 100644 --- a/www/apps/resources/references/tax_provider/interfaces/tax_provider.ITaxProvider/page.mdx +++ b/www/apps/resources/references/tax_provider/interfaces/tax_provider.ITaxProvider/page.mdx @@ -1,5 +1,10 @@ --- slug: /references/tax/provider +tags: + - tax + - server + - how to +sidebar_label: Create Tax Provider --- import { TypeList } from "docs-ui" diff --git a/www/apps/resources/sidebar.mjs b/www/apps/resources/sidebar.mjs index 78a4213420..687ee2c266 100644 --- a/www/apps/resources/sidebar.mjs +++ b/www/apps/resources/sidebar.mjs @@ -25,6 +25,7 @@ import { taxSidebar } from "./sidebars/tax.mjs" import { troubleshootingSidebar } from "./sidebars/troubleshooting.mjs" import { userSidebar } from "./sidebars/user.mjs" import { examplesSidebar } from "./sidebars/examples.mjs" +import { howToTutorialsSidebar } from "./sidebars/how-to-tutorials.mjs" /** @type {import("types").Sidebar.RawSidebar[]} */ export const sidebar = [ @@ -38,7 +39,6 @@ export const sidebar = [ title: "Overview", }, ...examplesSidebar, - ...recipesSidebar, { type: "separator", }, @@ -84,53 +84,7 @@ export const sidebar = [ { type: "category", title: "General", - children: [ - { - type: "sidebar", - sidebar_id: "deployment-guides", - title: "Deployment Guides", - children: [ - { - type: "link", - path: "/deployment", - title: "Overview", - }, - { - type: "separator", - }, - { - type: "link", - title: "Medusa Cloud", - path: "https://medusajs.com/pricing", - }, - { - type: "separator", - }, - { - type: "category", - title: "Self-Hosting", - children: [ - { - type: "link", - path: "https://docs.medusajs.com/learn/deployment/general", - title: "General", - }, - { - type: "link", - path: "/deployment/medusa-application/railway", - title: "Railway", - }, - ], - }, - { - type: "category", - title: "Next.js Starter", - autogenerate_path: "/deployment/storefront", - }, - ], - }, - ...troubleshootingSidebar, - ], + children: [...troubleshootingSidebar], }, { type: "category", @@ -141,31 +95,6 @@ export const sidebar = [ path: "/admin-widget-injection-zones", title: "Admin Widget Injection Zones", }, - { - type: "sidebar", - sidebar_id: "admin-components", - title: "Admin Components", - children: [ - { - type: "link", - path: "/admin-components", - title: "Overview", - }, - { - type: "separator", - }, - { - type: "category", - title: "Layouts", - autogenerate_path: "/admin-components/layouts", - }, - { - type: "category", - title: "Components", - autogenerate_path: "/admin-components/components", - }, - ], - }, ], }, { @@ -191,4 +120,14 @@ export const sidebar = [ }, ], }, + { + sidebar_id: "recipes", + title: "Recipes", + items: recipesSidebar, + }, + { + sidebar_id: "how-to-tutorials", + title: "How-To & Tutorials", + items: howToTutorialsSidebar, + }, ] diff --git a/www/apps/resources/sidebars/api-key.mjs b/www/apps/resources/sidebars/api-key.mjs index 854a2f4a24..4401b65e9b 100644 --- a/www/apps/resources/sidebars/api-key.mjs +++ b/www/apps/resources/sidebars/api-key.mjs @@ -16,7 +16,6 @@ export const apiKeySidebar = [ { type: "category", title: "Concepts", - initialOpen: false, children: [ { type: "link", @@ -34,7 +33,6 @@ export const apiKeySidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+auth", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -43,7 +41,6 @@ export const apiKeySidebar = [ { type: "category", title: "Storefront Guides", - initialOpen: false, autogenerate_tags: "storefront+apiKey,-jsSdk", autogenerate_as_ref: true, sort_sidebar: "alphabetize", @@ -53,7 +50,6 @@ export const apiKeySidebar = [ { type: "category", title: "Admin Guides", - initialOpen: false, autogenerate_tags: "admin+apiKey,-jsSdk", autogenerate_as_ref: true, sort_sidebar: "alphabetize", @@ -63,7 +59,6 @@ export const apiKeySidebar = [ { type: "category", title: "Admin User Guides", - initialOpen: false, autogenerate_tags: "userGuide+apiKey", autogenerate_as_ref: true, sort_sidebar: "alphabetize", @@ -73,7 +68,6 @@ export const apiKeySidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the API Key Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/auth.mjs b/www/apps/resources/sidebars/auth.mjs index 49199ca8dd..de5a00629c 100644 --- a/www/apps/resources/sidebars/auth.mjs +++ b/www/apps/resources/sidebars/auth.mjs @@ -21,7 +21,6 @@ export const authSidebar = [ { type: "category", title: "Concepts", - initialOpen: false, children: [ { type: "link", @@ -49,7 +48,6 @@ export const authSidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+auth", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -76,7 +74,6 @@ export const authSidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+auth,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -86,7 +83,6 @@ export const authSidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+auth,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -96,7 +92,6 @@ export const authSidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+auth", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -105,7 +100,6 @@ export const authSidebar = [ { type: "category", title: "Providers", - initialOpen: false, children: [ { type: "link", @@ -127,7 +121,6 @@ export const authSidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the Auth Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/cart.mjs b/www/apps/resources/sidebars/cart.mjs index 9de8840198..74d2e19b41 100644 --- a/www/apps/resources/sidebars/cart.mjs +++ b/www/apps/resources/sidebars/cart.mjs @@ -16,7 +16,6 @@ export const cartSidebar = [ { type: "category", title: "Concepts", - initialOpen: false, children: [ { type: "link", @@ -44,7 +43,6 @@ export const cartSidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+cart", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -61,7 +59,6 @@ export const cartSidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+cart,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -71,7 +68,6 @@ export const cartSidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+cart,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -81,7 +77,6 @@ export const cartSidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+cart", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -90,7 +85,6 @@ export const cartSidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the Cart Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/currency.mjs b/www/apps/resources/sidebars/currency.mjs index 856d70ac18..75cab01e15 100644 --- a/www/apps/resources/sidebars/currency.mjs +++ b/www/apps/resources/sidebars/currency.mjs @@ -16,7 +16,6 @@ export const currencySidebar = [ { type: "sub-category", title: "Concepts", - initialOpen: false, children: [ { type: "link", @@ -29,7 +28,6 @@ export const currencySidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+currency", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -39,7 +37,6 @@ export const currencySidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+currency,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -49,7 +46,6 @@ export const currencySidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+currency,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -59,7 +55,6 @@ export const currencySidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+currency", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -68,7 +63,6 @@ export const currencySidebar = [ { type: "sub-category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the Currency Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/customer.mjs b/www/apps/resources/sidebars/customer.mjs index 2f295580ff..2d303edeaa 100644 --- a/www/apps/resources/sidebars/customer.mjs +++ b/www/apps/resources/sidebars/customer.mjs @@ -16,7 +16,6 @@ export const customerSidebar = [ { type: "category", title: "Concepts", - initialOpen: false, children: [ { type: "link", @@ -34,7 +33,6 @@ export const customerSidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+customer", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -51,7 +49,6 @@ export const customerSidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+customer,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -61,7 +58,6 @@ export const customerSidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+customer,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -71,7 +67,6 @@ export const customerSidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+customer", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -80,7 +75,6 @@ export const customerSidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the Customer Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/examples.mjs b/www/apps/resources/sidebars/examples.mjs index e146ec063f..2fa2237182 100644 --- a/www/apps/resources/sidebars/examples.mjs +++ b/www/apps/resources/sidebars/examples.mjs @@ -5,11 +5,6 @@ export const examplesSidebar = [ sidebar_id: "examples", title: "Examples", children: [ - { - type: "link", - path: "/examples", - title: "Example Snippets", - }, { type: "ref", path: "/recipes", diff --git a/www/apps/resources/sidebars/fulfillment.mjs b/www/apps/resources/sidebars/fulfillment.mjs index 0584c3797c..f7c8dce5e7 100644 --- a/www/apps/resources/sidebars/fulfillment.mjs +++ b/www/apps/resources/sidebars/fulfillment.mjs @@ -21,7 +21,6 @@ export const fulfillmentSidebar = [ { type: "category", title: "Concepts", - initialOpen: false, autogenerate_tags: "concept+fulfillment", autogenerate_as_ref: true, children: [ @@ -56,7 +55,6 @@ export const fulfillmentSidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+fulfillment", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -78,7 +76,6 @@ export const fulfillmentSidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+fulfillment,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -88,7 +85,6 @@ export const fulfillmentSidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+fulfillment,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -98,7 +94,6 @@ export const fulfillmentSidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+fulfillment", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -107,7 +102,6 @@ export const fulfillmentSidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the Fulfillment Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/how-to-tutorials.mjs b/www/apps/resources/sidebars/how-to-tutorials.mjs new file mode 100644 index 0000000000..76bf2ce068 --- /dev/null +++ b/www/apps/resources/sidebars/how-to-tutorials.mjs @@ -0,0 +1,124 @@ +/** @type {import('types').Sidebar.SidebarItem[]} */ +export const howToTutorialsSidebar = [ + { + type: "link", + // TODO add page + path: "/how-to-tutorials", + title: "Overview", + }, + { + type: "link", + path: "/examples", + title: "Example Snippets", + }, + { + type: "separator", + }, + { + type: "category", + title: "How-To Guides", + children: [ + { + type: "sub-category", + title: "Server", + autogenerate_tags: "howTo+server", + autogenerate_as_ref: true, + sort_sidebar: "alphabetize", + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "howTo+admin", + autogenerate_as_ref: true, + sort_sidebar: "alphabetize", + children: [ + { + type: "link", + path: "/admin-components", + title: "Overview", + }, + { + type: "separator", + }, + { + type: "category", + title: "Layouts", + autogenerate_path: "/admin-components/layouts", + }, + { + type: "category", + title: "Components", + autogenerate_path: "/admin-components/components", + }, + ], + }, + ], + }, + { + type: "category", + title: "Tutorials", + children: [ + { + type: "link", + title: "Custom Item Pricing", + path: "/examples/guides/custom-item-price", + }, + { + type: "link", + title: "Wishlist", + path: "/plugins/guides/wishlist", + description: "Learn how to build a wishlist plugin.", + }, + { + type: "sub-category", + title: "Extend Modules", + autogenerate_tags: "tutorial+extendModule", + autogenerate_as_ref: true, + sort_sidebar: "alphabetize", + }, + ], + }, + { + type: "category", + title: "Deployment", + children: [ + { + type: "link", + path: "/deployment", + title: "Overview", + }, + { + type: "separator", + }, + { + type: "link", + title: "Medusa Cloud", + path: "https://medusajs.com/pricing", + }, + { + type: "separator", + }, + { + type: "category", + title: "Self-Hosting", + children: [ + { + type: "link", + path: "https://docs.medusajs.com/learn/deployment/general", + title: "General", + }, + { + type: "link", + path: "/deployment/medusa-application/railway", + title: "Railway", + }, + ], + }, + { + type: "category", + title: "Next.js Starter", + autogenerate_path: "/deployment/storefront", + }, + ], + }, +] diff --git a/www/apps/resources/sidebars/inventory.mjs b/www/apps/resources/sidebars/inventory.mjs index f7b1d6d8d1..db6ee54b0a 100644 --- a/www/apps/resources/sidebars/inventory.mjs +++ b/www/apps/resources/sidebars/inventory.mjs @@ -16,7 +16,6 @@ export const inventorySidebar = [ { type: "category", title: "Concepts", - initialOpen: false, autogenerate_tags: "concept+inventory", autogenerate_as_ref: true, children: [ @@ -46,7 +45,6 @@ export const inventorySidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+inventory", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -56,7 +54,6 @@ export const inventorySidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+inventory,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -66,7 +63,6 @@ export const inventorySidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+inventory,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -76,7 +72,6 @@ export const inventorySidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+inventory", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -85,7 +80,6 @@ export const inventorySidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the Inventory Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/order-module.mjs b/www/apps/resources/sidebars/order-module.mjs index 46cb792dcd..f3f6c41663 100644 --- a/www/apps/resources/sidebars/order-module.mjs +++ b/www/apps/resources/sidebars/order-module.mjs @@ -16,7 +16,6 @@ export const orderSidebar = [ { type: "category", title: "Concepts", - initialOpen: false, children: [ { type: "link", @@ -79,7 +78,6 @@ export const orderSidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+order", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -89,7 +87,6 @@ export const orderSidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+order,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -99,7 +96,6 @@ export const orderSidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+order,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -109,7 +105,6 @@ export const orderSidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+order", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -118,7 +113,6 @@ export const orderSidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the Order Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/payment.mjs b/www/apps/resources/sidebars/payment.mjs index 8383df75dd..b53e484ca4 100644 --- a/www/apps/resources/sidebars/payment.mjs +++ b/www/apps/resources/sidebars/payment.mjs @@ -21,7 +21,6 @@ export const paymentSidebar = [ { type: "category", title: "Concepts", - initialOpen: false, children: [ { type: "link", @@ -64,7 +63,6 @@ export const paymentSidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+payment", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -86,7 +84,6 @@ export const paymentSidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+payment,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -96,7 +93,6 @@ export const paymentSidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+payment,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -106,7 +102,6 @@ export const paymentSidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+payment", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -115,7 +110,6 @@ export const paymentSidebar = [ { type: "category", title: "Providers", - initialOpen: false, children: [ { type: "link", @@ -127,7 +121,6 @@ export const paymentSidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the Payment Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/plugins.mjs b/www/apps/resources/sidebars/plugins.mjs index ee352b96bb..25ef018e8e 100644 --- a/www/apps/resources/sidebars/plugins.mjs +++ b/www/apps/resources/sidebars/plugins.mjs @@ -10,18 +10,6 @@ export const pluginsSidebar = [ title: "Overview", path: "/plugins", }, - { - type: "category", - title: "Guides", - children: [ - { - type: "link", - title: "Wishlist", - path: "/plugins/guides/wishlist", - description: "Learn how to build a wishlist plugin.", - }, - ], - }, ], }, ] diff --git a/www/apps/resources/sidebars/pricing.mjs b/www/apps/resources/sidebars/pricing.mjs index 1e32b8916f..a3adc9b65a 100644 --- a/www/apps/resources/sidebars/pricing.mjs +++ b/www/apps/resources/sidebars/pricing.mjs @@ -16,7 +16,6 @@ export const pricingSidebar = [ { type: "category", title: "Concepts", - initialOpen: false, children: [ { type: "link", @@ -49,7 +48,6 @@ export const pricingSidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+pricing", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -59,7 +57,6 @@ export const pricingSidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+pricing,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -69,7 +66,6 @@ export const pricingSidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+pricing,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -79,7 +75,6 @@ export const pricingSidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+pricing", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -88,7 +83,6 @@ export const pricingSidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the Pricing Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/product.mjs b/www/apps/resources/sidebars/product.mjs index dfe642d5e2..2d9c42b2b0 100644 --- a/www/apps/resources/sidebars/product.mjs +++ b/www/apps/resources/sidebars/product.mjs @@ -16,7 +16,6 @@ export const productSidebar = [ { type: "category", title: "Concepts", - initialOpen: false, autogenerate_tags: "concept+product", autogenerate_as_ref: true, children: [ @@ -41,7 +40,6 @@ export const productSidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+product", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -68,7 +66,6 @@ export const productSidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+product,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -78,7 +75,6 @@ export const productSidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+product,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -88,7 +84,6 @@ export const productSidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+product", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -97,7 +92,6 @@ export const productSidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the Product Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/promotion.mjs b/www/apps/resources/sidebars/promotion.mjs index 1208c55fec..986dafa19a 100644 --- a/www/apps/resources/sidebars/promotion.mjs +++ b/www/apps/resources/sidebars/promotion.mjs @@ -16,7 +16,6 @@ export const promotionSidebar = [ { type: "category", title: "Concepts", - initialOpen: false, children: [ { type: "link", @@ -49,7 +48,6 @@ export const promotionSidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+promotion", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -66,7 +64,6 @@ export const promotionSidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+promotion,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -76,7 +73,6 @@ export const promotionSidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+promotion,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -86,7 +82,6 @@ export const promotionSidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+promotion", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -95,7 +90,6 @@ export const promotionSidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the Promotion Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/recipes.mjs b/www/apps/resources/sidebars/recipes.mjs index 35dc3d1ac9..45a7844f97 100644 --- a/www/apps/resources/sidebars/recipes.mjs +++ b/www/apps/resources/sidebars/recipes.mjs @@ -1,118 +1,111 @@ /** @type {import('types').Sidebar.SidebarItem[]} */ export const recipesSidebar = [ { - type: "sidebar", - sidebar_id: "recipes", - title: "Recipes", + type: "link", + path: "/recipes", + title: "Overview", + }, + { + type: "separator", + }, + { + type: "link", + path: "/recipes/marketplace", + title: "Marketplace", children: [ { type: "link", - path: "/recipes", - title: "Overview", - }, - { - type: "separator", + path: "/recipes/marketplace/examples/vendors", + title: "Example: Vendors", }, { type: "link", - path: "/recipes/marketplace", - title: "Marketplace", - children: [ - { - type: "link", - path: "/recipes/marketplace/examples/vendors", - title: "Example: Vendors", - }, - { - type: "link", - path: "/recipes/marketplace/examples/restaurant-delivery", - title: "Example: Restaurant-Delivery", - }, - ], - }, - { - type: "link", - path: "/recipes/subscriptions", - title: "Subscriptions", - children: [ - { - type: "link", - path: "/recipes/subscriptions/examples/standard", - title: "Example", - }, - ], - }, - { - type: "link", - path: "/recipes/digital-products", - title: "Digital Products", - children: [ - { - type: "link", - path: "/recipes/digital-products/examples/standard", - title: "Example", - }, - ], - }, - { - type: "link", - path: "/recipes/erp", - title: "Integrate ERP", - children: [ - { - type: "link", - path: "/recipes/erp/odoo", - title: "Example: Odoo Integration", - }, - ], - }, - { - type: "link", - path: "/recipes/b2b", - title: "B2B", - }, - { - type: "link", - path: "/recipes/commerce-automation", - title: "Commerce Automation", - children: [ - { - type: "link", - path: "/recipes/commerce-automation/restock-notification", - title: "Example: Restock Notifications", - }, - ], - }, - { - type: "link", - path: "/recipes/ecommerce", - title: "Ecommerce", - }, - { - type: "link", - path: "/recipes/multi-region-store", - title: "Multi-Region Store", - }, - { - type: "link", - path: "/recipes/omnichannel", - title: "Omnichannel Store", - }, - { - type: "link", - path: "/recipes/oms", - title: "OMS", - }, - { - type: "link", - path: "/recipes/personalized-products", - title: "Personalized Products", - }, - { - type: "link", - path: "/recipes/pos", - title: "POS", + path: "/recipes/marketplace/examples/restaurant-delivery", + title: "Example: Restaurant-Delivery", }, ], }, + { + type: "link", + path: "/recipes/subscriptions", + title: "Subscriptions", + children: [ + { + type: "link", + path: "/recipes/subscriptions/examples/standard", + title: "Example", + }, + ], + }, + { + type: "link", + path: "/recipes/digital-products", + title: "Digital Products", + children: [ + { + type: "link", + path: "/recipes/digital-products/examples/standard", + title: "Example", + }, + ], + }, + { + type: "link", + path: "/recipes/erp", + title: "Integrate ERP", + children: [ + { + type: "link", + path: "/recipes/erp/odoo", + title: "Example: Odoo Integration", + }, + ], + }, + { + type: "link", + path: "/recipes/b2b", + title: "B2B", + }, + { + type: "link", + path: "/recipes/commerce-automation", + title: "Commerce Automation", + children: [ + { + type: "link", + path: "/recipes/commerce-automation/restock-notification", + title: "Example: Restock Notifications", + }, + ], + }, + { + type: "link", + path: "/recipes/ecommerce", + title: "Ecommerce", + }, + { + type: "link", + path: "/recipes/multi-region-store", + title: "Multi-Region Store", + }, + { + type: "link", + path: "/recipes/omnichannel", + title: "Omnichannel Store", + }, + { + type: "link", + path: "/recipes/oms", + title: "OMS", + }, + { + type: "link", + path: "/recipes/personalized-products", + title: "Personalized Products", + }, + { + type: "link", + path: "/recipes/pos", + title: "POS", + }, ] diff --git a/www/apps/resources/sidebars/region.mjs b/www/apps/resources/sidebars/region.mjs index 4c2631d383..11608c9c57 100644 --- a/www/apps/resources/sidebars/region.mjs +++ b/www/apps/resources/sidebars/region.mjs @@ -16,7 +16,6 @@ export const regionSidebar = [ { type: "category", title: "Concepts", - initialOpen: false, children: [ { type: "link", @@ -29,7 +28,6 @@ export const regionSidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+region", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -39,7 +37,6 @@ export const regionSidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+region,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -49,7 +46,6 @@ export const regionSidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+region,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -59,7 +55,6 @@ export const regionSidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+region", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -68,7 +63,6 @@ export const regionSidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the Region Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/sales-channel.mjs b/www/apps/resources/sidebars/sales-channel.mjs index 95dcf5e7e1..23d39a9dc9 100644 --- a/www/apps/resources/sidebars/sales-channel.mjs +++ b/www/apps/resources/sidebars/sales-channel.mjs @@ -16,7 +16,6 @@ export const salesChannelSidebar = [ { type: "category", title: "Concepts", - initialOpen: false, autogenerate_tags: "concept+salesChannel", autogenerate_as_ref: true, children: [ @@ -36,7 +35,6 @@ export const salesChannelSidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+salesChannel", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -46,7 +44,6 @@ export const salesChannelSidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+salesChannel,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -56,7 +53,6 @@ export const salesChannelSidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+salesChannel,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -66,7 +62,6 @@ export const salesChannelSidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+salesChannel", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -75,7 +70,6 @@ export const salesChannelSidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the Sales Channel Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/sdk-tools.mjs b/www/apps/resources/sidebars/sdk-tools.mjs index 2b5904c8c8..c2b4cf3464 100644 --- a/www/apps/resources/sidebars/sdk-tools.mjs +++ b/www/apps/resources/sidebars/sdk-tools.mjs @@ -44,19 +44,16 @@ export const sdkToolsSidebar = [ type: "category", title: "Auth", autogenerate_path: "/references/js_sdk/auth/Auth/methods", - initialOpen: true, }, { type: "category", title: "Store", autogenerate_path: "/references/js_sdk/store/Store/properties", - initialOpen: true, }, { type: "category", title: "Admin", autogenerate_path: "/references/js_sdk/admin/Admin/properties", - initialOpen: true, }, ], }, diff --git a/www/apps/resources/sidebars/stock-location.mjs b/www/apps/resources/sidebars/stock-location.mjs index 99e9aa9a13..3b65b5427c 100644 --- a/www/apps/resources/sidebars/stock-location.mjs +++ b/www/apps/resources/sidebars/stock-location.mjs @@ -16,7 +16,6 @@ export const stockLocationSidebar = [ { type: "category", title: "Concepts", - initialOpen: false, autogenerate_tags: "concept+stockLocation", autogenerate_as_ref: true, children: [ @@ -36,7 +35,6 @@ export const stockLocationSidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+stockLocation", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -46,7 +44,6 @@ export const stockLocationSidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+stockLocation,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -56,7 +53,6 @@ export const stockLocationSidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+stockLocation,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -66,7 +62,6 @@ export const stockLocationSidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+stockLocation", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -75,7 +70,6 @@ export const stockLocationSidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the Stock Location Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/store.mjs b/www/apps/resources/sidebars/store.mjs index b415092b2e..02e219350c 100644 --- a/www/apps/resources/sidebars/store.mjs +++ b/www/apps/resources/sidebars/store.mjs @@ -16,7 +16,6 @@ export const storeSidebar = [ { type: "category", title: "Concepts", - initialOpen: false, children: [ { type: "link", @@ -29,7 +28,6 @@ export const storeSidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+store", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -39,7 +37,6 @@ export const storeSidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+store,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -49,7 +46,6 @@ export const storeSidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+store,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -59,7 +55,6 @@ export const storeSidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+store", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -68,7 +63,6 @@ export const storeSidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the Store Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/tax.mjs b/www/apps/resources/sidebars/tax.mjs index 8240395eba..fd86c86a40 100644 --- a/www/apps/resources/sidebars/tax.mjs +++ b/www/apps/resources/sidebars/tax.mjs @@ -21,7 +21,6 @@ export const taxSidebar = [ { type: "category", title: "Concepts", - initialOpen: false, children: [ { type: "link", @@ -44,7 +43,6 @@ export const taxSidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+tax", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -61,7 +59,6 @@ export const taxSidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+tax,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -71,7 +68,6 @@ export const taxSidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+tax,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -81,7 +77,6 @@ export const taxSidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+tax", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -90,7 +85,6 @@ export const taxSidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the Tax Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/apps/resources/sidebars/user.mjs b/www/apps/resources/sidebars/user.mjs index 71c5a1177b..af76530bd9 100644 --- a/www/apps/resources/sidebars/user.mjs +++ b/www/apps/resources/sidebars/user.mjs @@ -22,7 +22,6 @@ export const userSidebar = [ type: "category", title: "Server Guides", autogenerate_tags: "server+user", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -39,7 +38,6 @@ export const userSidebar = [ type: "category", title: "Storefront Guides", autogenerate_tags: "storefront+user,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -49,7 +47,6 @@ export const userSidebar = [ type: "category", title: "Admin Guides", autogenerate_tags: "admin+user,-jsSdk", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -59,7 +56,6 @@ export const userSidebar = [ type: "category", title: "Admin User Guides", autogenerate_tags: "userGuide+user", - initialOpen: false, autogenerate_as_ref: true, sort_sidebar: "alphabetize", description: @@ -68,7 +64,6 @@ export const userSidebar = [ { type: "category", title: "References", - initialOpen: false, description: "Find references for tools and resources related to the User Module, such as data models, methods, and more. These are useful for your customizations.", children: [ diff --git a/www/packages/build-scripts/src/utils/get-core-flows-ref-sidebar-children.ts b/www/packages/build-scripts/src/utils/get-core-flows-ref-sidebar-children.ts index 436d21e89e..fcfc440b97 100644 --- a/www/packages/build-scripts/src/utils/get-core-flows-ref-sidebar-children.ts +++ b/www/packages/build-scripts/src/utils/get-core-flows-ref-sidebar-children.ts @@ -92,7 +92,6 @@ export default async function getCoreFlowsRefSidebarChildren(): Promise< title: directory.name.replaceAll("_", " "), children: [], loaded: true, - initialOpen: false, } if (workflowItems.length) { diff --git a/www/packages/build-scripts/src/utils/number-sidebar-items.ts b/www/packages/build-scripts/src/utils/number-sidebar-items.ts index 8e03efd9ce..60f4ea2985 100644 --- a/www/packages/build-scripts/src/utils/number-sidebar-items.ts +++ b/www/packages/build-scripts/src/utils/number-sidebar-items.ts @@ -29,7 +29,6 @@ export default function numberSidebarItems( numberedItems.push( item.type === "category" ? { - initialOpen: false, ...item, title: item.chapterTitle, } @@ -38,7 +37,6 @@ export default function numberSidebarItems( title: item.chapterTitle, children: [], loaded: true, - initialOpen: false, } ) diff --git a/www/packages/docs-ui/src/components/Sidebar/Item/Category/index.tsx b/www/packages/docs-ui/src/components/Sidebar/Item/Category/index.tsx index ee6412ce5e..3575d57013 100644 --- a/www/packages/docs-ui/src/components/Sidebar/Item/Category/index.tsx +++ b/www/packages/docs-ui/src/components/Sidebar/Item/Category/index.tsx @@ -18,7 +18,7 @@ export const SidebarItemCategory = ({ }: SidebarItemCategoryProps) => { const [showLoading, setShowLoading] = useState(false) const [open, setOpen] = useState( - item.initialOpen !== undefined ? item.initialOpen : true + item.initialOpen !== undefined ? item.initialOpen : false ) const { isItemActive, diff --git a/www/packages/docs-ui/src/providers/Sidebar/index.tsx b/www/packages/docs-ui/src/providers/Sidebar/index.tsx index e91987a590..d7277b182c 100644 --- a/www/packages/docs-ui/src/providers/Sidebar/index.tsx +++ b/www/packages/docs-ui/src/providers/Sidebar/index.tsx @@ -311,6 +311,7 @@ export const SidebarProvider = ({ findSidebarItem({ sidebarItems: s.items, item: { type: "link", path: activePath, title: "" }, + compareTitles: false, }) !== undefined ) || sidebars[0] ) diff --git a/www/packages/docs-ui/src/utils/sidebar-utils.ts b/www/packages/docs-ui/src/utils/sidebar-utils.ts index f98e0c7442..bfc9ee1ec1 100644 --- a/www/packages/docs-ui/src/utils/sidebar-utils.ts +++ b/www/packages/docs-ui/src/utils/sidebar-utils.ts @@ -68,7 +68,7 @@ export const findSidebarItem = ({ }): Sidebar.SidebarItem | undefined => { let foundItem: Sidebar.SidebarItem | undefined sidebarItems.some((i) => { - if (areSidebarItemsEqual({ itemA: i, itemB: item })) { + if (areSidebarItemsEqual({ itemA: i, itemB: item, compareTitles })) { foundItem = i } else if (checkChildren && "children" in i && i.children) { foundItem = findSidebarItem({ diff --git a/www/packages/tags/src/tags/auth.ts b/www/packages/tags/src/tags/auth.ts index a27d1c5bfb..6c0d50be3c 100644 --- a/www/packages/tags/src/tags/auth.ts +++ b/www/packages/tags/src/tags/auth.ts @@ -3,6 +3,10 @@ export const auth = [ "title": "Reset Password", "path": "https://docs.medusajs.com/user-guide/reset-password" }, + { + "title": "Create Actor Type", + "path": "https://docs.medusajs.com/resources/commerce-modules/auth/create-actor-type" + }, { "title": "Log-out Customer in Storefront", "path": "https://docs.medusajs.com/resources/storefront-development/customers/log-out" @@ -27,6 +31,10 @@ export const auth = [ "title": "Third-Party or Social Login in Storefront", "path": "https://docs.medusajs.com/resources/storefront-development/customers/third-party-login" }, + { + "title": "Create Auth Provider", + "path": "https://docs.medusajs.com/resources/references/auth/provider" + }, { "title": "setAuthAppMetadataStep", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setAuthAppMetadataStep" diff --git a/www/packages/tags/src/tags/cache.ts b/www/packages/tags/src/tags/cache.ts new file mode 100644 index 0000000000..ad2014e8ac --- /dev/null +++ b/www/packages/tags/src/tags/cache.ts @@ -0,0 +1,6 @@ +export const cache = [ + { + "title": "Create Cache Module", + "path": "https://docs.medusajs.com/resources/architectural-modules/cache/create" + } +] \ No newline at end of file diff --git a/www/packages/tags/src/tags/cart.ts b/www/packages/tags/src/tags/cart.ts index c57bac9c99..682bb241ba 100644 --- a/www/packages/tags/src/tags/cart.ts +++ b/www/packages/tags/src/tags/cart.ts @@ -1,4 +1,8 @@ export const cart = [ + { + "title": "Extend Cart", + "path": "https://docs.medusajs.com/resources/commerce-modules/cart/extend" + }, { "title": "Implement Custom Line Item Pricing in Medusa", "path": "https://docs.medusajs.com/resources/examples/guides/custom-item-price" diff --git a/www/packages/tags/src/tags/customer.ts b/www/packages/tags/src/tags/customer.ts index a7f544c7a4..df560a3acc 100644 --- a/www/packages/tags/src/tags/customer.ts +++ b/www/packages/tags/src/tags/customer.ts @@ -11,6 +11,10 @@ export const customer = [ "title": "Customers Overview", "path": "https://docs.medusajs.com/user-guide/customers" }, + { + "title": "Extend Customer", + "path": "https://docs.medusajs.com/resources/commerce-modules/customer/extend" + }, { "title": "Manage Customer Addresses in Storefront", "path": "https://docs.medusajs.com/resources/storefront-development/customers/addresses" diff --git a/www/packages/tags/src/tags/event.ts b/www/packages/tags/src/tags/event.ts new file mode 100644 index 0000000000..a59397728b --- /dev/null +++ b/www/packages/tags/src/tags/event.ts @@ -0,0 +1,6 @@ +export const event = [ + { + "title": "Create Event Module", + "path": "https://docs.medusajs.com/resources/architectural-modules/event/create" + } +] \ No newline at end of file diff --git a/www/packages/tags/src/tags/extend-module.ts b/www/packages/tags/src/tags/extend-module.ts new file mode 100644 index 0000000000..30ee561425 --- /dev/null +++ b/www/packages/tags/src/tags/extend-module.ts @@ -0,0 +1,18 @@ +export const extendModule = [ + { + "title": "Extend Cart", + "path": "https://docs.medusajs.com/resources/commerce-modules/cart/extend" + }, + { + "title": "Extend Customer", + "path": "https://docs.medusajs.com/resources/commerce-modules/customer/extend" + }, + { + "title": "Extend Product", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/extend" + }, + { + "title": "Extend Promotion", + "path": "https://docs.medusajs.com/resources/commerce-modules/promotion/extend" + } +] \ No newline at end of file diff --git a/www/packages/tags/src/tags/fulfillment.ts b/www/packages/tags/src/tags/fulfillment.ts index 1d091b7864..9919c65769 100644 --- a/www/packages/tags/src/tags/fulfillment.ts +++ b/www/packages/tags/src/tags/fulfillment.ts @@ -267,6 +267,10 @@ export const fulfillment = [ "title": "createLocationFulfillmentSetWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createLocationFulfillmentSetWorkflow" }, + { + "title": "Create Fulfillment Provider", + "path": "https://docs.medusajs.com/resources/references/fulfillment/provider" + }, { "title": "fulfillment", "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/fulfillment" diff --git a/www/packages/tags/src/tags/how-to.ts b/www/packages/tags/src/tags/how-to.ts new file mode 100644 index 0000000000..d7cf263cef --- /dev/null +++ b/www/packages/tags/src/tags/how-to.ts @@ -0,0 +1,50 @@ +export const howTo = [ + { + "title": "Create Cache Module", + "path": "https://docs.medusajs.com/resources/architectural-modules/cache/create" + }, + { + "title": "Create Event Module", + "path": "https://docs.medusajs.com/resources/architectural-modules/event/create" + }, + { + "title": "Send Notification", + "path": "https://docs.medusajs.com/resources/architectural-modules/notification/send-notification" + }, + { + "title": "Create Actor Type", + "path": "https://docs.medusajs.com/resources/commerce-modules/auth/create-actor-type" + }, + { + "title": "Handle Password Reset Event", + "path": "https://docs.medusajs.com/resources/commerce-modules/auth/reset-password" + }, + { + "title": "Get Variant Prices", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price" + }, + { + "title": "Get Variant Price with Taxes", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes" + }, + { + "title": "Create Auth Provider", + "path": "https://docs.medusajs.com/resources/references/auth/provider" + }, + { + "title": "Create Fulfillment Provider", + "path": "https://docs.medusajs.com/resources/references/fulfillment/provider" + }, + { + "title": "Create Notification Provider", + "path": "https://docs.medusajs.com/resources/references/notification-provider-module" + }, + { + "title": "Create Payment Provider", + "path": "https://docs.medusajs.com/resources/references/payment/provider" + }, + { + "title": "Create Tax Provider", + "path": "https://docs.medusajs.com/resources/references/tax/provider" + } +] \ No newline at end of file diff --git a/www/packages/tags/src/tags/index.ts b/www/packages/tags/src/tags/index.ts index a525f6e220..c0f8fc0976 100644 --- a/www/packages/tags/src/tags/index.ts +++ b/www/packages/tags/src/tags/index.ts @@ -1,40 +1,45 @@ export * from "./user-guide.js" export * from "./fulfillment.js" export * from "./payment.js" +export * from "./cache.js" +export * from "./server.js" +export * from "./how-to.js" +export * from "./product.js" +export * from "./event.js" export * from "./pricing.js" export * from "./promotion.js" -export * from "./product.js" -export * from "./auth.js" +export * from "./user.js" export * from "./api-key.js" +export * from "./auth.js" +export * from "./notification.js" export * from "./workflow.js" export * from "./stock-location.js" +export * from "./store.js" export * from "./region.js" export * from "./sales-channel.js" -export * from "./user.js" -export * from "./store.js" export * from "./currency.js" +export * from "./cart.js" +export * from "./tax.js" +export * from "./tutorial.js" +export * from "./extend-module.js" +export * from "./concept.js" +export * from "./query.js" +export * from "./storefront.js" +export * from "./order.js" +export * from "./stripe.js" +export * from "./example.js" +export * from "./product-collection.js" +export * from "./product-category.js" +export * from "./publishable-api-key.js" +export * from "./step.js" +export * from "./event-bus.js" +export * from "./remote-query.js" +export * from "./link.js" +export * from "./locking.js" +export * from "./js-sdk.js" export * from "./customer.js" export * from "./inventory.js" -export * from "./cart.js" -export * from "./server.js" -export * from "./query.js" -export * from "./concept.js" -export * from "./example.js" -export * from "./publishable-api-key.js" -export * from "./checkout.js" -export * from "./product-collection.js" -export * from "./step.js" -export * from "./product-category.js" -export * from "./link.js" -export * from "./remote-query.js" -export * from "./locking.js" export * from "./file.js" -export * from "./js-sdk.js" -export * from "./event-bus.js" -export * from "./admin.js" -export * from "./storefront.js" +export * from "./checkout.js" export * from "./logger.js" -export * from "./tax.js" -export * from "./notification.js" -export * from "./stripe.js" -export * from "./order.js" +export * from "./admin.js" diff --git a/www/packages/tags/src/tags/notification.ts b/www/packages/tags/src/tags/notification.ts index 7bf807bbde..77f5901c34 100644 --- a/www/packages/tags/src/tags/notification.ts +++ b/www/packages/tags/src/tags/notification.ts @@ -1,4 +1,12 @@ export const notification = [ + { + "title": "Send Notification", + "path": "https://docs.medusajs.com/resources/architectural-modules/notification/send-notification" + }, + { + "title": "Handle Password Reset Event", + "path": "https://docs.medusajs.com/resources/commerce-modules/auth/reset-password" + }, { "title": "notifyOnFailureStep", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/notifyOnFailureStep" @@ -18,5 +26,9 @@ export const notification = [ { "title": "notification", "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/notification" + }, + { + "title": "Create Notification Provider", + "path": "https://docs.medusajs.com/resources/references/notification-provider-module" } ] \ No newline at end of file diff --git a/www/packages/tags/src/tags/payment.ts b/www/packages/tags/src/tags/payment.ts index b0a0928304..f6651a9140 100644 --- a/www/packages/tags/src/tags/payment.ts +++ b/www/packages/tags/src/tags/payment.ts @@ -214,5 +214,9 @@ export const payment = [ { "title": "payment", "path": "https://docs.medusajs.com/resources/references/js-sdk/store/payment" + }, + { + "title": "Create Payment Provider", + "path": "https://docs.medusajs.com/resources/references/payment/provider" } ] \ No newline at end of file diff --git a/www/packages/tags/src/tags/product.ts b/www/packages/tags/src/tags/product.ts index 22f98409f1..9cc1f79255 100644 --- a/www/packages/tags/src/tags/product.ts +++ b/www/packages/tags/src/tags/product.ts @@ -51,6 +51,10 @@ export const product = [ "title": "Inventory Kits", "path": "https://docs.medusajs.com/resources/commerce-modules/inventory/inventory-kit" }, + { + "title": "Extend Product", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/extend" + }, { "title": "Get Variant Prices", "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price" @@ -59,6 +63,10 @@ export const product = [ "title": "Get Variant Price with Taxes", "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes" }, + { + "title": "Build Wishlist Plugin", + "path": "https://docs.medusajs.com/resources/plugins/guides/wishlist" + }, { "title": "Implement Express Checkout with Medusa", "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout" diff --git a/www/packages/tags/src/tags/promotion.ts b/www/packages/tags/src/tags/promotion.ts index e7495e9084..bc41973c8c 100644 --- a/www/packages/tags/src/tags/promotion.ts +++ b/www/packages/tags/src/tags/promotion.ts @@ -15,6 +15,10 @@ export const promotion = [ "title": "Promotions Overview", "path": "https://docs.medusajs.com/user-guide/promotions" }, + { + "title": "Extend Promotion", + "path": "https://docs.medusajs.com/resources/commerce-modules/promotion/extend" + }, { "title": "getActionsToComputeFromPromotionsStep", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getActionsToComputeFromPromotionsStep" diff --git a/www/packages/tags/src/tags/server.ts b/www/packages/tags/src/tags/server.ts index abbde1cba5..251e838df7 100644 --- a/www/packages/tags/src/tags/server.ts +++ b/www/packages/tags/src/tags/server.ts @@ -1,4 +1,36 @@ export const server = [ + { + "title": "Create Cache Module", + "path": "https://docs.medusajs.com/resources/architectural-modules/cache/create" + }, + { + "title": "Create Event Module", + "path": "https://docs.medusajs.com/resources/architectural-modules/event/create" + }, + { + "title": "Send Notification", + "path": "https://docs.medusajs.com/resources/architectural-modules/notification/send-notification" + }, + { + "title": "Create Actor Type", + "path": "https://docs.medusajs.com/resources/commerce-modules/auth/create-actor-type" + }, + { + "title": "Handle Password Reset Event", + "path": "https://docs.medusajs.com/resources/commerce-modules/auth/reset-password" + }, + { + "title": "Extend Cart", + "path": "https://docs.medusajs.com/resources/commerce-modules/cart/extend" + }, + { + "title": "Extend Customer", + "path": "https://docs.medusajs.com/resources/commerce-modules/customer/extend" + }, + { + "title": "Extend Product", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/extend" + }, { "title": "Get Variant Prices", "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price" @@ -7,8 +39,36 @@ export const server = [ "title": "Get Variant Price with Taxes", "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes" }, + { + "title": "Extend Promotion", + "path": "https://docs.medusajs.com/resources/commerce-modules/promotion/extend" + }, { "title": "Implement Custom Line Item Pricing in Medusa", "path": "https://docs.medusajs.com/resources/examples/guides/custom-item-price" + }, + { + "title": "Build Wishlist Plugin", + "path": "https://docs.medusajs.com/resources/plugins/guides/wishlist" + }, + { + "title": "Create Auth Provider", + "path": "https://docs.medusajs.com/resources/references/auth/provider" + }, + { + "title": "Create Fulfillment Provider", + "path": "https://docs.medusajs.com/resources/references/fulfillment/provider" + }, + { + "title": "Create Notification Provider", + "path": "https://docs.medusajs.com/resources/references/notification-provider-module" + }, + { + "title": "Create Payment Provider", + "path": "https://docs.medusajs.com/resources/references/payment/provider" + }, + { + "title": "Create Tax Provider", + "path": "https://docs.medusajs.com/resources/references/tax/provider" } ] \ No newline at end of file diff --git a/www/packages/tags/src/tags/tax.ts b/www/packages/tags/src/tags/tax.ts index ba5c1a6191..d580ad1716 100644 --- a/www/packages/tags/src/tags/tax.ts +++ b/www/packages/tags/src/tags/tax.ts @@ -166,5 +166,9 @@ export const tax = [ { "title": "taxRegion", "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/taxRegion" + }, + { + "title": "Create Tax Provider", + "path": "https://docs.medusajs.com/resources/references/tax/provider" } ] \ No newline at end of file diff --git a/www/packages/tags/src/tags/tutorial.ts b/www/packages/tags/src/tags/tutorial.ts new file mode 100644 index 0000000000..eba8fd68a5 --- /dev/null +++ b/www/packages/tags/src/tags/tutorial.ts @@ -0,0 +1,26 @@ +export const tutorial = [ + { + "title": "Extend Cart", + "path": "https://docs.medusajs.com/resources/commerce-modules/cart/extend" + }, + { + "title": "Extend Customer", + "path": "https://docs.medusajs.com/resources/commerce-modules/customer/extend" + }, + { + "title": "Extend Product", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/extend" + }, + { + "title": "Extend Promotion", + "path": "https://docs.medusajs.com/resources/commerce-modules/promotion/extend" + }, + { + "title": "Implement Custom Line Item Pricing in Medusa", + "path": "https://docs.medusajs.com/resources/examples/guides/custom-item-price" + }, + { + "title": "Build Wishlist Plugin", + "path": "https://docs.medusajs.com/resources/plugins/guides/wishlist" + } +] \ No newline at end of file diff --git a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/auth-provider.ts b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/auth-provider.ts index 9afbf6b3ac..3902f8e031 100644 --- a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/auth-provider.ts +++ b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/auth-provider.ts @@ -9,6 +9,8 @@ const authProviderOptions: FormattingOptionsType = { reflectionDescription: `In this document, you’ll learn how to create an auth provider module and the methods you must implement in its main service.`, frontmatterData: { slug: "/references/auth/provider", + tags: ["auth", "server", "how to"], + sidebar_label: "Create Auth Provider", }, reflectionTitle: { fullReplacement: "How to Create an Auth Provider Module", diff --git a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/fulfillment-provider.ts b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/fulfillment-provider.ts index 6b238fcec4..fded0727d2 100644 --- a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/fulfillment-provider.ts +++ b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/fulfillment-provider.ts @@ -9,6 +9,8 @@ const fulfillmentProviderOptions: FormattingOptionsType = { reflectionDescription: `In this document, you’ll learn how to create a fulfillment provider module and the methods you must implement in its main service.`, frontmatterData: { slug: "/references/fulfillment/provider", + tags: ["fulfillment", "server", "how to"], + sidebar_label: "Create Fulfillment Provider", }, reflectionTitle: { fullReplacement: "How to Create a Fulfillment Provider Module", diff --git a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/notification.ts b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/notification.ts index d118f53e9a..664f07e2bb 100644 --- a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/notification.ts +++ b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/notification.ts @@ -9,6 +9,8 @@ const notificationOptions: FormattingOptionsType = { reflectionDescription: `In this document, you’ll learn how to create a notification provider module and the methods you must implement in it.`, frontmatterData: { slug: "/references/notification-provider-module", + tags: ["notification", "server", "how to"], + sidebar_label: "Create Notification Provider", }, reflectionTitle: { fullReplacement: "How to Create a Notification Provider Module", diff --git a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/payment-provider.ts b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/payment-provider.ts index b8513bd08e..29fead5d81 100644 --- a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/payment-provider.ts +++ b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/payment-provider.ts @@ -9,6 +9,8 @@ const paymentProviderOptions: FormattingOptionsType = { reflectionDescription: `In this document, you’ll learn how to create a Payment Provider to be used with the Payment Module.`, frontmatterData: { slug: "/references/payment/provider", + tags: ["payment", "server", "how to"], + sidebar_label: "Create Payment Provider", }, reflectionTitle: { fullReplacement: "How to Create a Payment Provider", diff --git a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/tax-provider.ts b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/tax-provider.ts index 61b52d5b40..418b3d30fa 100644 --- a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/tax-provider.ts +++ b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/tax-provider.ts @@ -8,6 +8,8 @@ const taxProviderOptions: FormattingOptionsType = { reflectionDescription: `In this document, you’ll learn how to create a tax provider to use with the Tax Module, and the methods to implement.`, frontmatterData: { slug: "/references/tax/provider", + tags: ["tax", "server", "how to"], + sidebar_label: "Create Tax Provider", }, reflectionTitle: { fullReplacement: "How to Create a Tax Provider", diff --git a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/frontmatter.ts b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/frontmatter.ts index a0596d1d7f..a381931292 100644 --- a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/frontmatter.ts +++ b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/frontmatter.ts @@ -3,8 +3,8 @@ import { MarkdownTheme } from "../../theme.js" import { stringify } from "yaml" import { replaceTemplateVariables } from "../../utils/reflection-template-strings.js" import { Reflection } from "typedoc" -import { FrontmatterData } from "types" -import { getTagComments, getTagsAsArray, getUniqueStrArray } from "utils" +import { FrontmatterData, Tag } from "types" +import { getTagComments, getTagsAsArray } from "utils" export default function (theme: MarkdownTheme) { Handlebars.registerHelper("frontmatter", function (this: Reflection) { @@ -30,9 +30,7 @@ export default function (theme: MarkdownTheme) { resolvedFrontmatter["tags"]?.push(...tagContent) }) if (resolvedFrontmatter["tags"]?.length) { - resolvedFrontmatter["tags"] = getUniqueStrArray( - resolvedFrontmatter["tags"] - ) + resolvedFrontmatter["tags"] = getUniqueTags(resolvedFrontmatter["tags"]) } return `---\n${stringify(resolvedFrontmatter).trim()}\n---\n\n` @@ -57,3 +55,14 @@ function resolveFrontmatterVariables( return tempFrontmatterData } + +function getUniqueTags(tags: Tag[]): Tag[] { + const tagsMap = new Map() + tags.forEach((tag) => { + const tagName = typeof tag === "string" ? tag : tag.name + + tagsMap.set(tagName, tag) + }) + + return Array.from(tagsMap.values()) +} diff --git a/www/utils/packages/types/lib/index.d.ts b/www/utils/packages/types/lib/index.d.ts index 9736fb648e..176dac7705 100644 --- a/www/utils/packages/types/lib/index.d.ts +++ b/www/utils/packages/types/lib/index.d.ts @@ -50,11 +50,18 @@ export type FormattingOptionsType = { [k: string]: FormattingOptionType } +export type Tag = + | string + | { + name: string + label: string + } + export type FrontmatterData = { slug?: string sidebar_label?: string displayed_sidebar?: string - tags?: string[] + tags?: Tag[] [k: string]: unknown }