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

docs: support multiple sidebars in a project (#11768)

Browse Source 
* changed to new sidebar across projects except resources

* finalize multi sidebar support

* clean up

* remove redundant property

* small changes

* fixes

* generate

* fix error

* fix initial open
This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-03-07 15:47:38 +02:00
1 parent 2a0bd86204
commit 5deb8eaf50
108 files changed
+37634 -36749
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/app/admin-components/page.mdx
+2 -2
View File
@@ -16,7 +16,7 @@ Refer to the [Medusa UI documentation](!ui!) for a full list of components.
Use these components to set the layout of your UI route.
<ChildDocs showItems={["Layouts"]} onlyTopLevel={false} />
<ChildDocs showItems={["Layouts"]} onlyTopLevel={false} hideTitle />
---
@@ -24,4 +24,4 @@ Use these components to set the layout of your UI route.
Use these components in your widgets and UI routes.
<ChildDocs showItems={["Components"]} onlyTopLevel={false} />
<ChildDocs showItems={["Components"]} onlyTopLevel={false} hideTitle />
www/apps/resources/app/examples/guides/quote-management/page.mdx
View File
Whitespace-only changes.
www/apps/resources/app/layout.tsx
+1 -7
View File
@@ -63,13 +63,7 @@ export default function RootLayout({
htmlClassName={clsx(inter.variable, robotoMono.variable)}
gaId={process.env.NEXT_PUBLIC_GA_ID}
>
<TightLayout
sidebarProps={{
expandItems: true,
}}
ProvidersComponent={Providers}
footerComponent={<Footer />}
>
<TightLayout ProvidersComponent={Providers} footerComponent={<Footer />}>
{children}
</TightLayout>
</BareboneLayout>
www/apps/resources/app/recipes/page.mdx
+1 -1
View File
@@ -8,4 +8,4 @@ export const metadata = {
This section of the documentation provides recipes for common use cases with example implementations.
<ChildDocs onlyTopLevel />
<ChildDocs onlyTopLevel hideItems={["Overview"]} />
www/apps/resources/app/storefront-development/page.mdx
+1 -1
View File
@@ -20,4 +20,4 @@ You can build your storefront from scratch, or built it on top of the [Next.js S
---
<ChildDocs hideItems={["General"]} />
<ChildDocs hideItems={["General", "Overview"]} />
www/apps/resources/app/troubleshooting/page.mdx
+1 -1
View File
@@ -12,4 +12,4 @@ The following troubleshooting guides are intended for technical users. If you're
</Note>
<ChildDocs />
<ChildDocs hideItems={["Overview"]} />
www/apps/resources/components/CommerceModuleSections/index.tsx
+6 -6
View File
@@ -12,7 +12,7 @@ export const CommerceModuleSections = () => {
showItems: ["Server Guides"],
defaultItemsPerRow: 2,
})
if (serverGuideItems?.default.length) {
if (serverGuideItems?.length) {
guideComponents.push(serverGuidesComponent)
}
const { items: storefrontGuideItems, component: storefrontGuidesComponent } =
@@ -20,7 +20,7 @@ export const CommerceModuleSections = () => {
showItems: ["Storefront Guides"],
defaultItemsPerRow: 2,
})
if (storefrontGuideItems?.default.length) {
if (storefrontGuideItems?.length) {
guideComponents.push(storefrontGuidesComponent)
}
const { items: adminGuideItems, component: adminGuidesComponent } =
@@ -28,7 +28,7 @@ export const CommerceModuleSections = () => {
showItems: ["Admin Guides"],
defaultItemsPerRow: 2,
})
if (adminGuideItems?.default.length) {
if (adminGuideItems?.length) {
guideComponents.push(adminGuidesComponent)
}
const { items: userGuideItems, component: userGuidesComponent } =
@@ -36,14 +36,14 @@ export const CommerceModuleSections = () => {
showItems: ["User Guides"],
defaultItemsPerRow: 2,
})
if (userGuideItems?.default.length) {
if (userGuideItems?.length) {
guideComponents.push(userGuidesComponent)
}
const { items: jsSdkItems, component: jsSdkComponent } = useChildDocs({
showItems: ["JS SDK"],
itemsPerRow: 2,
})
if (jsSdkItems?.default.length) {
if (jsSdkItems?.length) {
referenceComponents.push(jsSdkComponent)
}
const { items: referenceItems, component: referencesComponent } =
@@ -51,7 +51,7 @@ export const CommerceModuleSections = () => {
showItems: ["References"],
defaultItemsPerRow: 2,
})
if (referenceItems?.default.length) {
if (referenceItems?.length) {
referenceComponents.push(referencesComponent)
}
www/apps/resources/config/index.ts
+9 -7
View File
@@ -1,5 +1,5 @@
import { DocsConfig, SidebarItem } from "types"
import { generatedSidebar } from "../generated/sidebar.mjs"
import { DocsConfig, Sidebar } from "types"
import { generatedSidebars } from "../generated/sidebar.mjs"
import { globalConfig } from "docs-ui"
const baseUrl = process.env.NEXT_PUBLIC_BASE_URL || "http://localhost:3000"
@@ -9,16 +9,18 @@ export const config: DocsConfig = {
titleSuffix: "Medusa Development Resources",
baseUrl,
basePath: process.env.NEXT_PUBLIC_BASE_PATH,
sidebar: {
default: generatedSidebar as SidebarItem[],
mobile: [],
},
sidebars: generatedSidebars as Sidebar.Sidebar[],
project: {
title: "Development Resources",
key: "resources",
},
breadcrumbOptions: {
showCategories: true,
startItems: [
{
title: "Documentation",
link: baseUrl,
},
],
},
logo: `${process.env.NEXT_PUBLIC_BASE_PATH}/images/logo.png`,
}
www/apps/resources/generated/edit-dates.mjs
+3 -3
View File
@@ -123,7 +123,7 @@ export const generatedEditDates = {
"app/recipes/pos/page.mdx": "2025-02-26T12:42:52.949Z",
"app/recipes/subscriptions/examples/standard/page.mdx": "2025-03-03T15:02:56.854Z",
"app/recipes/subscriptions/page.mdx": "2025-02-26T12:31:49.933Z",
"app/recipes/page.mdx": "2024-07-11T15:56:41+00:00",
"app/recipes/page.mdx": "2025-03-07T07:48:28.203Z",
"app/service-factory-reference/methods/create/page.mdx": "2024-07-31T17:01:33+03:00",
"app/service-factory-reference/methods/delete/page.mdx": "2024-07-31T17:01:33+03:00",
"app/service-factory-reference/methods/list/page.mdx": "2024-07-31T17:01:33+03:00",
@@ -177,7 +177,7 @@ export const generatedEditDates = {
"app/storefront-development/regions/store-retrieve-region/page.mdx": "2024-12-19T16:36:22.800Z",
"app/storefront-development/regions/page.mdx": "2024-06-09T15:19:09+02:00",
"app/storefront-development/tips/page.mdx": "2024-12-19T16:36:32.938Z",
"app/storefront-development/page.mdx": "2024-12-10T09:23:20.666Z",
"app/storefront-development/page.mdx": "2025-03-07T07:49:27.809Z",
"app/troubleshooting/cors-errors/page.mdx": "2024-05-03T17:36:38+03:00",
"app/troubleshooting/create-medusa-app-errors/page.mdx": "2024-07-11T10:29:13+03:00",
"app/troubleshooting/database-errors/page.mdx": "2024-05-03T17:36:38+03:00",
@@ -2101,7 +2101,7 @@ export const generatedEditDates = {
"app/admin-components/components/json-view-section/page.mdx": "2024-10-07T11:15:58.833Z",
"app/admin-components/components/section-row/page.mdx": "2024-10-07T11:15:58.832Z",
"app/admin-components/components/table/page.mdx": "2025-03-03T14:53:37.952Z",
"app/admin-components/page.mdx": "2024-10-07T11:09:49.493Z",
"app/admin-components/page.mdx": "2025-03-07T08:00:46.960Z",
"app/admin-components/layouts/single-column/page.mdx": "2024-10-07T11:16:06.435Z",
"app/admin-components/layouts/two-column/page.mdx": "2024-10-07T11:16:10.092Z",
"app/admin-components/components/forms/page.mdx": "2024-10-09T12:48:04.229Z",
www/apps/resources/generated/files-map.mjs
+4
View File
@@ -787,6 +787,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/examples/guides/custom-item-price/page.mdx",
"pathname": "/examples/guides/custom-item-price"
},
{
"filePath": "/www/apps/resources/app/examples/guides/quote-management/page.mdx",
"pathname": "/examples/guides/quote-management"
},
{
"filePath": "/www/apps/resources/app/examples/page.mdx",
"pathname": "/examples"
www/apps/resources/generated/sidebar.mjs
+25052 -24493
View File
File diff suppressed because it is too large. Load diff
www/apps/resources/providers/sidebar.tsx
+1 -6
View File
@@ -14,13 +14,8 @@ const SidebarProvider = ({ children }: SidebarProviderProps) => {
return (
<UiSidebarProvider
shouldHandlePathChange={true}
shouldHandleHashChange={false}
scrollableElement={scrollableElement}
initialItems={config.sidebar}
staticSidebarItems={true}
disableActiveTransition={true}
projectName="resources"
sidebars={config.sidebars}
>
{children}
</UiSidebarProvider>
www/apps/resources/scripts/prepare.mjs
+3 -3
View File
@@ -5,9 +5,9 @@ import { sidebar } from "../sidebar.mjs"
async function main() {
await generateSidebar(sidebar)
await generateSlugChanges()
await generateFilesMap()
await generateEditedDates()
// await generateSlugChanges()
// await generateFilesMap()
// await generateEditedDates()
}
void main()
www/apps/resources/sidebar.mjs
+133 -157
View File
@@ -24,195 +24,171 @@ import { storefrontGuidesSidebar } from "./sidebars/storefront.mjs"
import { taxSidebar } from "./sidebars/tax.mjs"
import { troubleshootingSidebar } from "./sidebars/troubleshooting.mjs"
import { userSidebar } from "./sidebars/user.mjs"
import { sidebarAttachHrefCommonOptions } from "./utils/sidebar-attach-common-options.mjs"
import { examplesSidebar } from "./sidebars/examples.mjs"
/** @type {import('types').RawSidebarItem[]} */
export const sidebar = sidebarAttachHrefCommonOptions([
/** @type {import("types").Sidebar.RawSidebar[]} */
export const sidebar = [
{
type: "link",
path: "/",
title: "Overview",
},
...examplesSidebar,
{
type: "link",
path: "/recipes",
title: "Recipes",
isChildSidebar: true,
children: recipesSidebar,
},
{
type: "separator",
},
{
type: "link",
path: "/commerce-modules",
title: "Commerce Modules",
hideChildren: true,
sort_sidebar: "alphabetize",
children: [
...apiKeySidebar,
...authSidebar,
...cartSidebar,
...currencySidebar,
...customerSidebar,
...fulfillmentSidebar,
...inventorySidebar,
...orderSidebar,
...paymentSidebar,
...pricingSidebar,
...productSidebar,
...promotionSidebar,
...regionSidebar,
...salesChannelSidebar,
...stockLocationSidebar,
...storeSidebar,
...taxSidebar,
...userSidebar,
],
},
{
type: "link",
path: "/architectural-modules",
title: "Architectural Modules",
isChildSidebar: true,
sort_sidebar: "alphabetize",
children: architecturalModulesSidebar,
},
{
type: "link",
path: "/integrations",
title: "Integrations",
isChildSidebar: true,
sort_sidebar: "alphabetize",
children: integrationsSidebar,
},
{
type: "ref",
path: "/plugins",
title: "Plugins",
isChildSidebar: true,
children: pluginsSidebar,
},
{
type: "link",
path: "/storefront-development",
title: "Storefront Development",
isChildSidebar: true,
children: storefrontGuidesSidebar,
},
{
type: "separator",
},
{
type: "category",
title: "SDKs and Tools",
children: sdkToolsSidebar,
},
{
type: "category",
title: "General",
children: [
sidebar_id: "resources",
title: "Development Resources",
items: [
{
type: "link",
path: "/references/medusa-config",
title: "Medusa Configurations",
path: "/",
title: "Overview",
},
...examplesSidebar,
...recipesSidebar,
{
type: "separator",
},
{
type: "link",
path: "/deployment",
title: "Deployment Guides",
isChildSidebar: true,
path: "/commerce-modules",
title: "Commerce Modules",
hideChildren: true,
sort_sidebar: "alphabetize",
children: [
...apiKeySidebar,
...authSidebar,
...cartSidebar,
...currencySidebar,
...customerSidebar,
...fulfillmentSidebar,
...inventorySidebar,
...orderSidebar,
...paymentSidebar,
...pricingSidebar,
...productSidebar,
...promotionSidebar,
...regionSidebar,
...salesChannelSidebar,
...stockLocationSidebar,
...storeSidebar,
...taxSidebar,
...userSidebar,
],
},
...architecturalModulesSidebar,
...integrationsSidebar,
...pluginsSidebar,
...storefrontGuidesSidebar,
{
type: "separator",
},
{
type: "category",
title: "SDKs and Tools",
children: sdkToolsSidebar,
},
{
type: "category",
title: "General",
children: [
{
type: "link",
title: "Medusa Cloud",
path: "https://medusajs.com/pricing",
},
{
type: "separator",
},
{
type: "category",
title: "Self-Hosting",
type: "sidebar",
sidebar_id: "deployment-guides",
title: "Deployment Guides",
children: [
{
type: "link",
path: "https://docs.medusajs.com/learn/deployment/general",
title: "General",
path: "/deployment",
title: "Overview",
},
{
type: "separator",
},
{
type: "link",
path: "/deployment/medusa-application/railway",
title: "Railway",
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",
},
],
},
{
type: "category",
title: "Next.js Starter",
autogenerate_path: "/deployment/storefront",
},
...troubleshootingSidebar,
],
},
{
type: "link",
path: "/troubleshooting",
title: "Troubleshooting Guides",
isChildSidebar: true,
children: troubleshootingSidebar,
},
],
},
{
type: "category",
title: "Admin",
children: [
{
type: "link",
path: "/admin-widget-injection-zones",
title: "Admin Widget Injection Zones",
},
{
type: "link",
path: "/admin-components",
title: "Admin Components",
isChildSidebar: true,
type: "category",
title: "Admin",
children: [
{
type: "category",
title: "Layouts",
autogenerate_path: "/admin-components/layouts",
type: "link",
path: "/admin-widget-injection-zones",
title: "Admin Widget Injection Zones",
},
{
type: "category",
title: "Components",
autogenerate_path: "/admin-components/components",
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",
},
],
},
],
},
],
},
{
type: "category",
title: "Lists",
children: [
{
type: "link",
path: "/medusa-container-resources",
title: "Container Dependencies",
type: "category",
title: "Lists",
children: [
{
type: "link",
path: "/medusa-container-resources",
title: "Container Dependencies",
},
{
type: "link",
path: "/events-reference",
title: "Events List",
},
],
},
{
type: "link",
path: "/events-reference",
title: "Events List",
type: "category",
title: "References",
children: referencesSidebar,
},
],
},
{
type: "category",
title: "References",
children: referencesSidebar,
},
])
]
www/apps/resources/sidebars/api-key.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const apiKeySidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "api-key",
title: "API Key Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -131,12 +131,19 @@ export const apiKeySidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/api-key",
type: "sidebar",
sidebar_id: "api-key-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "API Key Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/api-key",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -147,12 +154,19 @@ export const apiKeySidebar = [
],
},
{
type: "link",
path: "/references/api-key/models",
type: "sidebar",
sidebar_id: "api-key-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "API Key Module Data Models Reference",
children: [
{
type: "link",
path: "/references/api-key/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/architectural-modules.mjs
+129 -114
View File
@@ -1,161 +1,176 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const architecturalModulesSidebar = [
{
type: "category",
title: "Cache Modules",
type: "sidebar",
sidebar_id: "architectural-modules",
title: "Architectural Modules",
children: [
{
type: "link",
path: "/architectural-modules/cache",
path: "/architectural-modules",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/cache/in-memory",
title: "In-Memory",
type: "separator",
},
{
type: "link",
path: "/architectural-modules/cache/redis",
title: "Redis",
},
{
type: "sub-category",
title: "Guides",
type: "category",
title: "Cache Modules",
children: [
{
type: "link",
path: "/architectural-modules/cache/create",
title: "Create Cache Module",
path: "/architectural-modules/cache",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/cache/in-memory",
title: "In-Memory",
},
{
type: "link",
path: "/architectural-modules/cache/redis",
title: "Redis",
},
{
type: "sub-category",
title: "Guides",
children: [
{
type: "link",
path: "/architectural-modules/cache/create",
title: "Create Cache Module",
},
],
},
],
},
],
},
{
type: "category",
title: "Event Modules",
children: [
{
type: "link",
path: "/architectural-modules/event",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/event/local",
title: "Local",
},
{
type: "link",
path: "/architectural-modules/event/redis",
title: "Redis",
},
{
type: "sub-category",
title: "Guides",
type: "category",
title: "Event Modules",
children: [
{
type: "link",
path: "/architectural-modules/event/create",
title: "Create Event Module",
path: "/architectural-modules/event",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/event/local",
title: "Local",
},
{
type: "link",
path: "/architectural-modules/event/redis",
title: "Redis",
},
{
type: "sub-category",
title: "Guides",
children: [
{
type: "link",
path: "/architectural-modules/event/create",
title: "Create Event Module",
},
],
},
],
},
],
},
{
type: "category",
title: "File Module Providers",
children: [
{
type: "link",
path: "/architectural-modules/file",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/file/local",
title: "Local",
},
{
type: "link",
path: "/architectural-modules/file/s3",
title: "AWS S3 (and Compatible APIs)",
},
{
type: "sub-category",
title: "Guides",
type: "category",
title: "File Module Providers",
children: [
{
type: "link",
path: "/references/file-provider-module",
title: "Create File Provider",
path: "/architectural-modules/file",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/file/local",
title: "Local",
},
{
type: "link",
path: "/architectural-modules/file/s3",
title: "AWS S3 (and Compatible APIs)",
},
{
type: "sub-category",
title: "Guides",
children: [
{
type: "link",
path: "/references/file-provider-module",
title: "Create File Provider",
},
],
},
],
},
],
},
{
type: "category",
title: "Notification Module Providers",
children: [
{
type: "link",
path: "/architectural-modules/notification",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/notification/local",
title: "Local",
},
{
type: "link",
path: "/architectural-modules/notification/sendgrid",
title: "SendGrid",
},
{
type: "sub-category",
title: "Guides",
type: "category",
title: "Notification Module Providers",
children: [
{
type: "link",
path: "/references/notification-provider-module",
title: "Create Notification Provider",
path: "/architectural-modules/notification",
title: "Overview",
},
{
type: "link",
path: "/integrations/guides/resend",
title: "Integrate Resend",
path: "/architectural-modules/notification/local",
title: "Local",
},
{
type: "link",
path: "/architectural-modules/notification/send-notification",
title: "Send Notification",
path: "/architectural-modules/notification/sendgrid",
title: "SendGrid",
},
{
type: "sub-category",
title: "Guides",
children: [
{
type: "link",
path: "/references/notification-provider-module",
title: "Create Notification Provider",
},
{
type: "link",
path: "/integrations/guides/resend",
title: "Integrate Resend",
},
{
type: "link",
path: "/architectural-modules/notification/send-notification",
title: "Send Notification",
},
],
},
],
},
],
},
{
type: "category",
title: "Workflow Engine Modules",
children: [
{
type: "link",
path: "/architectural-modules/workflow-engine",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/workflow-engine/in-memory",
title: "In-Memory",
},
{
type: "link",
path: "/architectural-modules/workflow-engine/redis",
title: "Redis",
type: "category",
title: "Workflow Engine Modules",
children: [
{
type: "link",
path: "/architectural-modules/workflow-engine",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/workflow-engine/in-memory",
title: "In-Memory",
},
{
type: "link",
path: "/architectural-modules/workflow-engine/redis",
title: "Redis",
},
],
},
],
},
www/apps/resources/sidebars/auth.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const authSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "auth",
title: "Auth Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -173,12 +173,19 @@ export const authSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/auth",
type: "sidebar",
sidebar_id: "auth-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Auth Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/auth",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -188,12 +195,19 @@ export const authSidebar = [
],
},
{
type: "link",
path: "/references/auth/models",
type: "sidebar",
sidebar_id: "auth-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Auth Module Data Models Reference",
children: [
{
type: "link",
path: "/references/auth/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/cart.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const cartSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "cart",
title: "Cart Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -148,12 +148,19 @@ export const cartSidebar = [
title: "Events Reference",
},
{
type: "link",
path: "/references/cart",
type: "sidebar",
sidebar_id: "cart-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Cart Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/cart",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -163,12 +170,19 @@ export const cartSidebar = [
],
},
{
type: "link",
path: "/references/cart/models",
type: "sidebar",
sidebar_id: "cart-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Cart Module Data Models Reference",
children: [
{
type: "link",
path: "/references/cart/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/currency.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const currencySidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "currency",
title: "Currency Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -99,12 +99,19 @@ export const currencySidebar = [
],
},
{
type: "link",
path: "/references/currency",
type: "sidebar",
sidebar_id: "currency-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Currency Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/currency",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -114,12 +121,19 @@ export const currencySidebar = [
],
},
{
type: "link",
path: "/references/currency/models",
type: "sidebar",
sidebar_id: "currency-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Currency Module Data Models Reference",
children: [
{
type: "link",
path: "/references/currency/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/customer.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const customerSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "customer",
title: "Customer Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -143,12 +143,19 @@ export const customerSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/customer",
type: "sidebar",
sidebar_id: "customer-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Customer Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/customer",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -158,12 +165,19 @@ export const customerSidebar = [
],
},
{
type: "link",
path: "/references/customer/models",
type: "sidebar",
sidebar_id: "customer-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Customer Module Data Models Reference",
children: [
{
type: "link",
path: "/references/customer/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/examples.mjs
+4 -12
View File
@@ -1,13 +1,12 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const examplesSidebar = [
{
type: "link",
path: "/examples",
type: "sidebar",
sidebar_id: "examples",
title: "Examples",
isChildSidebar: true,
children: [
{
type: "ref",
type: "link",
path: "/examples",
title: "Example Snippets",
},
@@ -32,13 +31,6 @@ export const examplesSidebar = [
autogenerate_tags: "example+server",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
children: [
{
type: "link",
title: "Custom Item Price",
path: "/examples/guides/custom-item-price",
},
],
},
{
type: "category",
www/apps/resources/sidebars/fulfillment.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const fulfillmentSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "fulfillment",
title: "Fulfillment Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -170,12 +170,19 @@ export const fulfillmentSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/fulfillment",
type: "sidebar",
sidebar_id: "fulfillment-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Fulfillment Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/fulfillment",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -185,12 +192,19 @@ export const fulfillmentSidebar = [
],
},
{
type: "link",
path: "/references/fulfillment/models",
type: "sidebar",
sidebar_id: "fulfillment-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Fulfillment Module Data Models Reference",
children: [
{
type: "link",
path: "/references/fulfillment/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/integrations.mjs
+79 -64
View File
@@ -1,78 +1,93 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const integrationsSidebar = [
{
type: "category",
title: "Auth",
type: "sidebar",
sidebar_id: "integrations",
title: "Integrations",
children: [
{
type: "link",
path: "/commerce-modules/auth/auth-providers/google",
title: "Google",
path: "/integrations",
title: "Overview",
},
{
type: "link",
path: "/commerce-modules/auth/auth-providers/github",
title: "GitHub",
},
],
},
{
type: "category",
title: "CMS",
children: [
{
type: "link",
path: "/integrations/guides/sanity",
title: "Sanity",
},
],
},
{
type: "category",
title: "File",
children: [
{
type: "link",
path: "/architectural-modules/file/s3",
title: "AWS",
},
],
},
{
type: "category",
title: "Fulfillment",
children: [
{
type: "link",
path: "/integrations/guides/shipstation",
title: "ShipStation",
},
],
},
{
type: "category",
title: "Notification",
children: [
{
type: "link",
path: "/architectural-modules/notification/sendgrid",
title: "SendGrid",
type: "separator",
},
{
type: "link",
path: "/integrations/guides/resend",
title: "Resend",
type: "category",
title: "Auth",
children: [
{
type: "link",
path: "/commerce-modules/auth/auth-providers/google",
title: "Google",
},
{
type: "link",
path: "/commerce-modules/auth/auth-providers/github",
title: "GitHub",
},
],
},
],
},
{
type: "category",
title: "Payment",
children: [
{
type: "link",
path: "/commerce-modules/payment/payment-provider/stripe",
title: "Stripe",
type: "category",
title: "CMS",
children: [
{
type: "link",
path: "/integrations/guides/sanity",
title: "Sanity",
},
],
},
{
type: "category",
title: "File",
children: [
{
type: "link",
path: "/architectural-modules/file/s3",
title: "AWS",
},
],
},
{
type: "category",
title: "Fulfillment",
children: [
{
type: "link",
path: "/integrations/guides/shipstation",
title: "ShipStation",
},
],
},
{
type: "category",
title: "Notification",
children: [
{
type: "link",
path: "/architectural-modules/notification/sendgrid",
title: "SendGrid",
},
{
type: "link",
path: "/integrations/guides/resend",
title: "Resend",
},
],
},
{
type: "category",
title: "Payment",
children: [
{
type: "link",
path: "/commerce-modules/payment/payment-provider/stripe",
title: "Stripe",
},
],
},
],
},
www/apps/resources/sidebars/inventory.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const inventorySidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "inventory",
title: "Inventory Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -143,12 +143,19 @@ export const inventorySidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/inventory-next",
type: "sidebar",
sidebar_id: "inventory-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Inventory Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/inventory-next",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -158,12 +165,19 @@ export const inventorySidebar = [
],
},
{
type: "link",
path: "/references/inventory-next/models",
type: "sidebar",
sidebar_id: "inventory-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Inventory Module Data Models Reference",
children: [
{
type: "link",
path: "/references/inventory-next/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/order-module.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const orderSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "order",
title: "Order Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -181,12 +181,19 @@ export const orderSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/order",
type: "sidebar",
sidebar_id: "order-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Order Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/order",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -196,12 +203,19 @@ export const orderSidebar = [
],
},
{
type: "link",
path: "/references/order/models",
type: "sidebar",
sidebar_id: "order-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Order Module Data Models Reference",
children: [
{
type: "link",
path: "/references/order/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/payment.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const paymentSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "payment",
title: "Payment Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -185,12 +185,19 @@ export const paymentSidebar = [
title: "Events Reference",
},
{
type: "link",
path: "/references/payment",
type: "sidebar",
sidebar_id: "payment-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Payment Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/payment",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -200,12 +207,19 @@ export const paymentSidebar = [
],
},
{
type: "link",
path: "/references/payment/models",
type: "sidebar",
sidebar_id: "payment-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Payment Module Data Models Reference",
children: [
{
type: "link",
path: "/references/payment/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/plugins.mjs
+18 -11
View File
@@ -1,19 +1,26 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const pluginsSidebar = [
{
type: "link",
title: "Overview",
path: "/plugins",
},
{
type: "category",
title: "Guides",
type: "sidebar",
sidebar_id: "plugins",
title: "Plugins",
children: [
{
type: "link",
title: "Wishlist",
path: "/plugins/guides/wishlist",
description: "Learn how to build a wishlist plugin.",
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.",
},
],
},
],
},
www/apps/resources/sidebars/pricing.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const pricingSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "pricing",
title: "Pricing Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -146,12 +146,19 @@ export const pricingSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/pricing",
type: "sidebar",
sidebar_id: "pricing-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Pricing Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/pricing",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -161,12 +168,19 @@ export const pricingSidebar = [
],
},
{
type: "link",
path: "/references/pricing/models",
type: "sidebar",
sidebar_id: "pricing-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Pricing Module Data Models Reference",
children: [
{
type: "link",
path: "/references/pricing/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/product.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const productSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "product",
title: "Product Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -160,12 +160,19 @@ export const productSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/product",
type: "sidebar",
sidebar_id: "product-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Product Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/product",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -175,12 +182,19 @@ export const productSidebar = [
],
},
{
type: "link",
path: "/references/product/models",
type: "sidebar",
sidebar_id: "product-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Product Module Data Models Reference",
children: [
{
type: "link",
path: "/references/product/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/promotion.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const promotionSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "promotion",
title: "Promotion Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -153,12 +153,19 @@ export const promotionSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/promotion",
type: "sidebar",
sidebar_id: "promotion-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Promotion Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/promotion",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -169,12 +176,19 @@ export const promotionSidebar = [
],
},
{
type: "link",
path: "/references/promotion/models",
type: "sidebar",
sidebar_id: "promotion-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Promotion Module Data Models Reference",
children: [
{
type: "link",
path: "/references/promotion/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/recipes.mjs
+94 -79
View File
@@ -1,103 +1,118 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const recipesSidebar = [
{
type: "link",
path: "/recipes/marketplace",
title: "Marketplace",
type: "sidebar",
sidebar_id: "recipes",
title: "Recipes",
children: [
{
type: "link",
path: "/recipes/marketplace/examples/vendors",
title: "Example: Vendors",
path: "/recipes",
title: "Overview",
},
{
type: "separator",
},
{
type: "link",
path: "/recipes/marketplace/examples/restaurant-delivery",
title: "Example: Restaurant-Delivery",
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",
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",
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",
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",
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",
},
],
},
{
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",
},
]
www/apps/resources/sidebars/references.mjs
+60 -20
View File
@@ -1,12 +1,19 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const referencesSidebar = [
{
type: "link",
path: "/references/workflows",
type: "sidebar",
sidebar_id: "workflows-sdk-reference",
title: "Workflows SDK",
childSidebarTitle: "Workflows SDK Reference",
isChildSidebar: true,
children: [
{
type: "link",
path: "/references/workflows",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Functions",
@@ -15,12 +22,19 @@ export const referencesSidebar = [
],
},
{
type: "link",
path: "/references/data-model",
type: "sidebar",
sidebar_id: "dml-reference",
title: "Data Model Language",
childSidebarTitle: "Data Model Language Reference",
isChildSidebar: true,
children: [
{
type: "link",
path: "/references/data-model",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "link",
path: "/references/data-model/define",
@@ -53,11 +67,18 @@ export const referencesSidebar = [
],
},
{
type: "link",
path: "/service-factory-reference",
type: "sidebar",
sidebar_id: "service-factory-reference",
title: "Service Factory",
isChildSidebar: true,
children: [
{
type: "link",
path: "/service-factory-reference",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -71,25 +92,44 @@ export const referencesSidebar = [
],
},
{
type: "link",
path: "/references/helper-steps",
type: "sidebar",
sidebar_id: "helper-steps-reference",
title: "Helper Steps",
isChildSidebar: true,
autogenerate_path: "/references/helper_steps/functions",
children: [
{
type: "link",
path: "/references/helper-steps",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Steps",
autogenerate_path: "/references/helper_steps/functions",
},
],
},
{
type: "link",
type: "sidebar",
sidebar_id: "core-flows",
title: "Core Workflows",
path: "/medusa-workflows-reference",
isChildSidebar: true,
custom_autogenerate: "core-flows",
},
{
type: "link",
type: "sidebar",
sidebar_id: "test-tools-reference",
title: "Testing Framework",
path: "/test-tools-reference",
isChildSidebar: true,
children: [
{
type: "link",
path: "/test-tools-reference",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Functions",
www/apps/resources/sidebars/region.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const regionSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "region",
title: "Region Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -131,12 +131,19 @@ export const regionSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/region",
type: "sidebar",
sidebar_id: "region-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Region Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/region",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -146,12 +153,19 @@ export const regionSidebar = [
],
},
{
type: "link",
path: "/references/region/models",
type: "sidebar",
sidebar_id: "region-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Region Module Data Models Reference",
children: [
{
type: "link",
path: "/references/region/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/sales-channel.mjs
+20 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const salesChannelSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "sales-channel",
title: "Sales Channel Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -138,12 +138,16 @@ export const salesChannelSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/sales-channel",
type: "sidebar",
sidebar_id: "sales-channel-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Sales Channel Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/sales-channel",
title: "Reference Overview",
},
{
type: "category",
title: "Methods",
@@ -153,12 +157,19 @@ export const salesChannelSidebar = [
],
},
{
type: "link",
path: "/references/sales-channel/models",
type: "sidebar",
sidebar_id: "sales-channel-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Sales Channel Module Data Models Reference",
children: [
{
type: "link",
path: "/references/sales-channel/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/sdk-tools.mjs
+15 -10
View File
@@ -1,4 +1,4 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const sdkToolsSidebar = [
{
type: "link",
@@ -6,10 +6,9 @@ export const sdkToolsSidebar = [
title: "create-medusa-app",
},
{
type: "link",
path: "/medusa-cli",
type: "sidebar",
sidebar_id: "medusa-cli",
title: "Medusa CLI",
isChildSidebar: true,
childSidebarTitle: "Medusa CLI Reference",
children: [
{
@@ -28,12 +27,19 @@ export const sdkToolsSidebar = [
],
},
{
type: "link",
path: "/js-sdk",
type: "sidebar",
sidebar_id: "js-sdk",
title: "JS SDK",
isChildSidebar: true,
childSidebarTitle: "JS SDK Reference",
children: [
{
type: "link",
path: "/js-sdk",
title: "Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Auth",
@@ -55,10 +61,9 @@ export const sdkToolsSidebar = [
],
},
{
type: "link",
path: "/nextjs-starter",
type: "sidebar",
sidebar_id: "nextjs-starter",
title: "Next.js Starter Storefront",
isChildSidebar: true,
children: [
{
type: "link",
www/apps/resources/sidebars/stock-location.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const stockLocationSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "stock-location",
title: "Stock Location Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -133,12 +133,19 @@ export const stockLocationSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/stock-location-next",
type: "sidebar",
sidebar_id: "stock-location-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Stock Location Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/stock-location-next",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -148,12 +155,19 @@ export const stockLocationSidebar = [
],
},
{
type: "link",
path: "/references/stock-location-next/models",
type: "sidebar",
sidebar_id: "stock-location-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Stock Location Module Data Models Reference",
children: [
{
type: "link",
path: "/references/stock-location-next/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/store.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const storeSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "store",
title: "Store Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -126,12 +126,19 @@ export const storeSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/store",
type: "sidebar",
sidebar_id: "store-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Store Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/store",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -141,12 +148,19 @@ export const storeSidebar = [
],
},
{
type: "link",
path: "/references/store/models",
type: "sidebar",
sidebar_id: "store-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Store Module Data Models Reference",
children: [
{
type: "link",
path: "/references/store/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/storefront.mjs
+240 -225
View File
@@ -1,259 +1,274 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const storefrontGuidesSidebar = [
{
type: "category",
title: "General",
type: "sidebar",
sidebar_id: "storefront-development",
title: "Storefront Development",
children: [
{
type: "link",
path: "/storefront-development/tips",
title: "Tips",
},
{
type: "link",
path: "/storefront-development/publishable-api-keys",
title: "Publishable API Key",
},
],
},
{
type: "category",
title: "Examples",
children: [
{
type: "link",
path: "/storefront-development/guides/express-checkout",
title: "Express Checkout Storefront",
},
],
},
{
type: "category",
title: "Regions",
children: [
{
type: "link",
path: "/storefront-development/regions",
path: "/storefront-development",
title: "Overview",
},
{
type: "link",
path: "/storefront-development/regions/list",
title: "List Regions",
type: "separator",
},
{
type: "link",
path: "/storefront-development/regions/store-retrieve-region",
title: "Store and Retrieve Regions",
},
{
type: "link",
path: "/storefront-development/regions/context",
title: "Region React Context",
},
],
},
{
type: "category",
title: "Products",
children: [
{
type: "link",
path: "/storefront-development/products/list",
title: "List Products",
},
{
type: "link",
path: "/storefront-development/products/retrieve",
title: "Retrieve a Product",
},
{
type: "link",
path: "/storefront-development/products/variants",
title: "Select a Variant",
},
{
type: "link",
path: "/storefront-development/products/price",
title: "Retrieve Variant Prices",
autogenerate_path: "storefront-development/products/price/examples",
},
{
type: "link",
path: "/storefront-development/products/inventory",
title: "Retrieve Variant Inventory",
},
],
},
{
type: "category",
title: "Product Categories",
children: [
{
type: "link",
path: "/storefront-development/products/categories/list",
title: "List Categories",
},
{
type: "link",
path: "/storefront-development/products/categories/retrieve",
title: "Retrieve a Category",
},
{
type: "link",
path: "/storefront-development/products/categories/products",
title: "Retrieve a Category's Products",
},
{
type: "link",
path: "/storefront-development/products/categories/nested-categories",
title: "Retrieve Nested Categories",
},
],
},
{
type: "category",
title: "Product Collections",
children: [
{
type: "link",
path: "/storefront-development/products/collections/list",
title: "List Collections",
},
{
type: "link",
path: "/storefront-development/products/collections/retrieve",
title: "Retrieve a Collection",
},
{
type: "link",
path: "/storefront-development/products/collections/products",
title: "Retrieve a Collection's Products",
},
],
},
{
type: "category",
title: "Carts",
children: [
{
type: "link",
path: "/storefront-development/cart/create",
title: "Create Cart",
},
{
type: "link",
path: "/storefront-development/cart/retrieve",
title: "Retrieve Cart",
},
{
type: "link",
path: "/storefront-development/cart/context",
title: "Cart React Context",
},
{
type: "link",
path: "/storefront-development/cart/update",
title: "Update Cart",
},
{
type: "link",
path: "/storefront-development/cart/manage-items",
title: "Manage Line Items",
},
],
},
{
type: "category",
title: "Checkout",
children: [
{
type: "link",
path: "/storefront-development/checkout",
title: "Overview",
},
{
type: "link",
path: "/storefront-development/checkout/email",
title: "1. Enter Email",
},
{
type: "link",
path: "/storefront-development/checkout/address",
title: "2. Set Address",
},
{
type: "link",
path: "/storefront-development/checkout/shipping",
title: "3. Choose Shipping Method",
},
{
type: "link",
path: "/storefront-development/checkout/payment",
title: "4. Choose Payment Provider",
type: "category",
title: "General",
children: [
{
type: "link",
path: "/storefront-development/checkout/payment/stripe",
title: "Example: Stripe",
path: "/storefront-development/tips",
title: "Tips",
},
{
type: "link",
path: "/storefront-development/publishable-api-keys",
title: "Publishable API Key",
},
],
},
{
type: "link",
path: "/storefront-development/checkout/complete-cart",
title: "5. Complete Cart",
},
],
},
{
type: "category",
title: "Customers",
children: [
{
type: "link",
path: "/storefront-development/customers/register",
title: "Register Customer",
type: "category",
title: "Examples",
children: [
{
type: "link",
path: "/storefront-development/guides/express-checkout",
title: "Express Checkout Storefront",
},
],
},
{
type: "link",
path: "/storefront-development/customers/login",
title: "Login Customer",
type: "category",
title: "Regions",
children: [
{
type: "link",
path: "/storefront-development/regions",
title: "Overview",
},
{
type: "link",
path: "/storefront-development/regions/list",
title: "List Regions",
},
{
type: "link",
path: "/storefront-development/regions/store-retrieve-region",
title: "Store and Retrieve Regions",
},
{
type: "link",
path: "/storefront-development/regions/context",
title: "Region React Context",
},
],
},
{
type: "link",
path: "/storefront-development/customers/third-party-login",
title: "Third-Party (Social) Login",
type: "category",
title: "Products",
children: [
{
type: "link",
path: "/storefront-development/products/list",
title: "List Products",
},
{
type: "link",
path: "/storefront-development/products/retrieve",
title: "Retrieve a Product",
},
{
type: "link",
path: "/storefront-development/products/variants",
title: "Select a Variant",
},
{
type: "link",
path: "/storefront-development/products/price",
title: "Retrieve Variant Prices",
autogenerate_path: "storefront-development/products/price/examples",
},
{
type: "link",
path: "/storefront-development/products/inventory",
title: "Retrieve Variant Inventory",
},
],
},
{
type: "link",
path: "/storefront-development/customers/reset-password",
title: "Reset Password",
type: "category",
title: "Product Categories",
children: [
{
type: "link",
path: "/storefront-development/products/categories/list",
title: "List Categories",
},
{
type: "link",
path: "/storefront-development/products/categories/retrieve",
title: "Retrieve a Category",
},
{
type: "link",
path: "/storefront-development/products/categories/products",
title: "Retrieve a Category's Products",
},
{
type: "link",
path: "/storefront-development/products/categories/nested-categories",
title: "Retrieve Nested Categories",
},
],
},
{
type: "link",
path: "/storefront-development/customers/retrieve",
title: "Retrieve Customer",
type: "category",
title: "Product Collections",
children: [
{
type: "link",
path: "/storefront-development/products/collections/list",
title: "List Collections",
},
{
type: "link",
path: "/storefront-development/products/collections/retrieve",
title: "Retrieve a Collection",
},
{
type: "link",
path: "/storefront-development/products/collections/products",
title: "Retrieve a Collection's Products",
},
],
},
{
type: "link",
path: "/storefront-development/customers/context",
title: "Customer React Context",
type: "category",
title: "Carts",
children: [
{
type: "link",
path: "/storefront-development/cart/create",
title: "Create Cart",
},
{
type: "link",
path: "/storefront-development/cart/retrieve",
title: "Retrieve Cart",
},
{
type: "link",
path: "/storefront-development/cart/context",
title: "Cart React Context",
},
{
type: "link",
path: "/storefront-development/cart/update",
title: "Update Cart",
},
{
type: "link",
path: "/storefront-development/cart/manage-items",
title: "Manage Line Items",
},
],
},
{
type: "link",
path: "/storefront-development/customers/profile",
title: "Edit Customer Profile",
type: "category",
title: "Checkout",
children: [
{
type: "link",
path: "/storefront-development/checkout",
title: "Overview",
},
{
type: "link",
path: "/storefront-development/checkout/email",
title: "1. Enter Email",
},
{
type: "link",
path: "/storefront-development/checkout/address",
title: "2. Set Address",
},
{
type: "link",
path: "/storefront-development/checkout/shipping",
title: "3. Choose Shipping Method",
},
{
type: "link",
path: "/storefront-development/checkout/payment",
title: "4. Choose Payment Provider",
children: [
{
type: "link",
path: "/storefront-development/checkout/payment/stripe",
title: "Example: Stripe",
},
],
},
{
type: "link",
path: "/storefront-development/checkout/complete-cart",
title: "5. Complete Cart",
},
],
},
{
type: "link",
path: "/storefront-development/customers/addresses",
title: "Manage Customer Addresses",
},
{
type: "link",
path: "/storefront-development/customers/log-out",
title: "Log-out Customer",
type: "category",
title: "Customers",
children: [
{
type: "link",
path: "/storefront-development/customers/register",
title: "Register Customer",
},
{
type: "link",
path: "/storefront-development/customers/login",
title: "Login Customer",
},
{
type: "link",
path: "/storefront-development/customers/third-party-login",
title: "Third-Party (Social) Login",
},
{
type: "link",
path: "/storefront-development/customers/reset-password",
title: "Reset Password",
},
{
type: "link",
path: "/storefront-development/customers/retrieve",
title: "Retrieve Customer",
},
{
type: "link",
path: "/storefront-development/customers/context",
title: "Customer React Context",
},
{
type: "link",
path: "/storefront-development/customers/profile",
title: "Edit Customer Profile",
},
{
type: "link",
path: "/storefront-development/customers/addresses",
title: "Manage Customer Addresses",
},
{
type: "link",
path: "/storefront-development/customers/log-out",
title: "Log-out Customer",
},
],
},
],
},
www/apps/resources/sidebars/tax.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const taxSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "tax",
title: "Tax Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -148,12 +148,19 @@ export const taxSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/tax",
type: "sidebar",
sidebar_id: "tax-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Tax Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/tax",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -162,12 +169,19 @@ export const taxSidebar = [
],
},
{
type: "link",
path: "/references/tax/models",
type: "sidebar",
sidebar_id: "tax-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Tax Module Data Models Reference",
children: [
{
type: "link",
path: "/references/tax/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/troubleshooting.mjs
+92 -77
View File
@@ -1,99 +1,114 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const troubleshootingSidebar = [
{
type: "category",
title: "Installation",
type: "sidebar",
sidebar_id: "troubleshooting",
title: "Troubleshooting",
children: [
{
type: "link",
path: "/troubleshooting/create-medusa-app-errors",
title: "Create Medusa App Errors",
path: "/troubleshooting",
title: "Overview",
},
{
type: "link",
path: "/troubleshooting/errors-installing-cli",
title: "Errors Installing CLI",
type: "separator",
},
{
type: "link",
path: "/troubleshooting/general-errors",
title: "General Errors",
},
],
},
{
type: "category",
title: "Medusa Application",
children: [
{
type: "link",
path: "/troubleshooting/eaddrinuse",
title: "EADDRINUSE Error",
type: "category",
title: "Installation",
children: [
{
type: "link",
path: "/troubleshooting/create-medusa-app-errors",
title: "Create Medusa App Errors",
},
{
type: "link",
path: "/troubleshooting/errors-installing-cli",
title: "Errors Installing CLI",
},
{
type: "link",
path: "/troubleshooting/general-errors",
title: "General Errors",
},
],
},
{
type: "link",
path: "/troubleshooting/database-errors",
title: "Database Errors",
type: "category",
title: "Medusa Application",
children: [
{
type: "link",
path: "/troubleshooting/eaddrinuse",
title: "EADDRINUSE Error",
},
{
type: "link",
path: "/troubleshooting/database-errors",
title: "Database Errors",
},
{
type: "link",
path: "/troubleshooting/dist-imports",
title: "Importing from /dist",
},
{
type: "link",
path: "/troubleshooting/workflow-errors",
title: "Workflow Errors",
},
{
type: "link",
path: "/troubleshooting/test-errors",
title: "Test Errors",
},
],
},
{
type: "link",
path: "/troubleshooting/dist-imports",
title: "Importing from /dist",
type: "category",
title: "Admin Development",
children: [
{
type: "link",
path: "/troubleshooting/medusa-admin/no-widget-route",
title: "Widget or Route not Showing",
},
],
},
{
type: "link",
path: "/troubleshooting/workflow-errors",
title: "Workflow Errors",
type: "category",
title: "Upgrade",
children: [
{
type: "link",
path: "/troubleshooting/errors-after-upgrading",
title: "Errors After Upgrading",
},
],
},
{
type: "link",
path: "/troubleshooting/test-errors",
title: "Test Errors",
type: "category",
title: "Frontend",
children: [
{
type: "link",
path: "/troubleshooting/cors-errors",
title: "CORS Errors",
},
],
},
],
},
{
type: "category",
title: "Admin Development",
children: [
{
type: "link",
path: "/troubleshooting/medusa-admin/no-widget-route",
title: "Widget or Route not Showing",
},
],
},
{
type: "category",
title: "Upgrade",
children: [
{
type: "link",
path: "/troubleshooting/errors-after-upgrading",
title: "Errors After Upgrading",
},
],
},
{
type: "category",
title: "Frontend",
children: [
{
type: "link",
path: "/troubleshooting/cors-errors",
title: "CORS Errors",
},
],
},
{
type: "category",
title: "Integrations",
hasTitleStyling: true,
children: [
{
type: "link",
path: "/troubleshooting/s3",
title: "S3 Module Provider Errors",
type: "category",
title: "Integrations",
hasTitleStyling: true,
children: [
{
type: "link",
path: "/troubleshooting/s3",
title: "S3 Module Provider Errors",
},
],
},
],
},
www/apps/resources/sidebars/user.mjs
+23 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const userSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "user",
title: "User Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -131,12 +131,19 @@ export const userSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/user",
type: "sidebar",
sidebar_id: "user-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "User Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/user",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -146,12 +153,19 @@ export const userSidebar = [
],
},
{
type: "link",
path: "/references/user/models",
type: "sidebar",
sidebar_id: "user-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "User Module Data Models Reference",
children: [
{
type: "link",
path: "/references/user/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/types/index.d.ts
Vendored
-6
View File
@@ -1,6 +0,0 @@
import { SidebarItemType as UiSidebarItemType } from "docs-ui"
export declare type SidebarItemType = UiSidebarItemType & {
autogenerate_path?: string
children?: SidebarItemType[]
}
www/apps/resources/utils/sidebar-attach-common-options.mjs
-24
View File
@@ -1,24 +0,0 @@
/** @type {Partial<import("../types").RawSidebarItem>} */
const commonOptions = {
loaded: true,
isPathHref: true,
}
/**
*
* @param {import("types").RawSidebarItem[]} sidebar
* @returns {import("types").RawSidebarItem[]}
*/
export function sidebarAttachHrefCommonOptions(sidebar) {
return sidebar.map((item) => {
if (item.type === "separator") {
return item
}
return {
...commonOptions,
...item,
children: sidebarAttachHrefCommonOptions(item.children || []),
}
})
}