docs: added examples page (#9587)

- Added an examples page with examples of all different concepts in Medusa. We'll probably add more examples with time as we see the need for them.
- Small fixes in different pages.

Preview: https://resources-docs-ocb5uyp0o-medusajs.vercel.app/v2/resources/examples
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-10-16 10:07:39 +00:00
1 parent ddcb749bc4
commit 6e856d3156
15 files changed
+4301 -546

No files matched your search

@@ -1,4 +1,4 @@
import { ChildDocs } from "docs-ui"
import { CardList } from "docs-ui"
export const metadata = {
title: `Payment Module Provider`,
@@ -18,7 +18,15 @@ After the payment session is authorized, the payment provider is associated with
### List of Payment Module Providers
<ChildDocs type="item" />
<CardList
items={[
{
href: "/commerce-modules/payment/payment-provider/stripe",
title: "Stripe"
}
]}
/>
---
File diff suppressed because it is too large. Load diff
+25 -4
View File
@@ -1,4 +1,4 @@
import { ChildDocs } from "docs-ui"
import { CardList } from "docs-ui"
export const metadata = {
title: `Integrations`,
@@ -12,7 +12,14 @@ Find in this document Medusa's modules that integrate third-party services and s
Learn how to create a payment provider in [this guide](/references/payment/provider).
<ChildDocs showItems={["Payment"]} hideTitle />
<CardList
items={[
{
href: "/architectural-modules/file/s3",
title: "AWS S3 (and Compatible APIs)"
}
]}
/>
---
@@ -20,7 +27,14 @@ Learn how to create a payment provider in [this guide](/references/payment/provi
Learn how to create a notification provider in [this guide](/references/notification-provider-module).
<ChildDocs showItems={["Notification"]} hideTitle />
<CardList
items={[
{
href: "/architectural-modules/notification/sendgrid",
title: "SendGrid"
}
]}
/>
---
@@ -28,4 +42,11 @@ Learn how to create a notification provider in [this guide](/references/notifica
Learn how to create a file provider in [this guide](/references/file-provider-module).
<ChildDocs showItems={["File"]} hideTitle />
<CardList
items={[
{
href: "/commerce-modules/payment/payment-provider/stripe",
title: "Stripe"
}
]}
/>
+2 -1
View File
@@ -124,7 +124,7 @@ export const generatedEditDates = {
"app/deployment/medusa-application/railway/page.mdx": "2024-10-15T12:50:50.981Z",
"app/deployment/storefront/vercel/page.mdx": "2024-07-26T07:21:31+00:00",
"app/deployment/page.mdx": "2024-07-25T09:55:22+03:00",
"app/integrations/page.mdx": "2024-07-19T08:49:08+00:00",
"app/integrations/page.mdx": "2024-10-15T12:26:39.839Z",
"app/medusa-cli/page.mdx": "2024-08-28T11:25:32.382Z",
"app/medusa-container-resources/page.mdx": "2024-09-30T08:43:53.173Z",
"app/medusa-workflows-reference/page.mdx": "2024-09-30T08:43:53.174Z",
@@ -2295,5 +2295,6 @@ export const generatedEditDates = {
"references/fulfillment/interfaces/fulfillment.IFulfillmentModuleService/page.mdx": "2024-10-14T15:28:22.238Z",
"references/types/CommonTypes/interfaces/types.CommonTypes.RequestQueryFields/page.mdx": "2024-10-14T15:27:49.882Z",
"references/utils/utils.ProductUtils/page.mdx": "2024-10-14T15:27:51.874Z",
"app/examples/page.mdx": "2024-10-15T12:19:18.820Z",
"app/medusa-cli/commands/build/page.mdx": "2024-10-16T08:16:27.618Z"
}
@@ -591,6 +591,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/events-reference/page.mdx",
"pathname": "/events-reference"
},
{
"filePath": "/www/apps/resources/app/examples/page.mdx",
"pathname": "/examples"
},
{
"filePath": "/www/apps/resources/app/integrations/page.mdx",
"pathname": "/integrations"
+160 -199
View File
@@ -7,6 +7,158 @@ export const generatedSidebar = [
"title": "Overview",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/recipes",
"title": "Recipes",
"isChildSidebar": true,
"children": [
{
"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/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/ecommerce",
"title": "Ecommerce",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/recipes/integrate-ecommerce-stack",
"title": "Integrate Ecommerce Stack",
"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"
},
{
"loaded": true,
"isPathHref": true,
@@ -7581,205 +7733,6 @@ export const generatedSidebar = [
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/integrations",
"title": "Integrations",
"isChildSidebar": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "File",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/file/s3",
"title": "AWS S3 (and Compatible APIs)",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Notification",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/notification/sendgrid",
"title": "SendGrid",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Payment",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/payment/payment-provider/stripe",
"title": "Stripe",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/recipes",
"title": "Recipes",
"isChildSidebar": true,
"children": [
{
"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/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/ecommerce",
"title": "Ecommerce",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/recipes/integrate-ecommerce-stack",
"title": "Integrate Ecommerce Stack",
"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": []
}
]
},
{
"loaded": true,
"isPathHref": true,
@@ -8022,6 +7975,14 @@ export const generatedSidebar = [
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/integrations",
"title": "Integrations",
"children": []
},
{
"type": "separator"
},
+146 -177
View File
@@ -7,6 +7,108 @@ export const sidebar = sidebarAttachHrefCommonOptions([
path: "/",
title: "Overview",
},
{
type: "link",
path: "/examples",
title: "Examples",
},
{
type: "link",
path: "/recipes",
title: "Recipes",
isChildSidebar: true,
children: [
{
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/b2b",
title: "B2B",
},
{
type: "link",
path: "/recipes/commerce-automation",
title: "Commerce Automation",
},
{
type: "link",
path: "/recipes/ecommerce",
title: "Ecommerce",
},
{
type: "link",
path: "/recipes/integrate-ecommerce-stack",
title: "Integrate Ecommerce Stack",
},
{
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: "separator",
},
{
type: "link",
path: "/commerce-modules",
@@ -1485,141 +1587,6 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
type: "link",
path: "/integrations",
title: "Integrations",
isChildSidebar: true,
children: [
{
type: "category",
title: "File",
children: [
{
type: "link",
path: "/architectural-modules/file/s3",
title: "AWS S3 (and Compatible APIs)",
},
],
},
{
type: "category",
title: "Notification",
children: [
{
type: "link",
path: "/architectural-modules/notification/sendgrid",
title: "SendGrid",
},
],
},
{
type: "category",
title: "Payment",
children: [
{
type: "link",
path: "/commerce-modules/payment/payment-provider/stripe",
title: "Stripe",
},
],
},
],
},
{
type: "link",
path: "/recipes",
title: "Recipes",
isChildSidebar: true,
children: [
{
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/b2b",
title: "B2B",
},
{
type: "link",
path: "/recipes/commerce-automation",
title: "Commerce Automation",
},
{
type: "link",
path: "/recipes/ecommerce",
title: "Ecommerce",
},
{
type: "link",
path: "/recipes/integrate-ecommerce-stack",
title: "Integrate Ecommerce Stack",
},
{
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: "/architectural-modules",
@@ -1783,45 +1750,9 @@ export const sidebar = sidebarAttachHrefCommonOptions([
],
},
{
type: "separator",
},
{
type: "category",
title: "SDKs and Tools",
children: [
{
type: "link",
path: "/create-medusa-app",
title: "create-medusa-app",
},
{
type: "link",
path: "/medusa-cli",
title: "Medusa CLI",
isChildSidebar: true,
childSidebarTitle: "Medusa CLI Reference",
children: [
{
type: "link",
path: "/medusa-cli",
title: "Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Commands",
autogenerate_path: "medusa-cli/commands",
},
],
},
{
type: "link",
path: "/nextjs-starter",
title: "Next.js Starter",
},
],
type: "link",
path: "/integrations",
title: "Integrations",
},
{
type: "link",
@@ -2094,6 +2025,47 @@ export const sidebar = sidebarAttachHrefCommonOptions([
{
type: "separator",
},
{
type: "category",
title: "SDKs and Tools",
children: [
{
type: "link",
path: "/create-medusa-app",
title: "create-medusa-app",
},
{
type: "link",
path: "/medusa-cli",
title: "Medusa CLI",
isChildSidebar: true,
childSidebarTitle: "Medusa CLI Reference",
children: [
{
type: "link",
path: "/medusa-cli",
title: "Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Commands",
autogenerate_path: "medusa-cli/commands",
},
],
},
{
type: "link",
path: "/nextjs-starter",
title: "Next.js Starter",
},
],
},
{
type: "separator",
},
{
type: "category",
title: "General",
@@ -2233,9 +2205,6 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
type: "separator",
},
{
type: "category",
title: "Admin",