finalize changes

This commit is contained in:
Shahed Nasser
2025-03-11 12:18:40 +02:00
parent 8d23c97af9
commit a26f48fde2
21 changed files with 9330 additions and 9188 deletions
+69 -8
View File
@@ -1,11 +1,12 @@
import { CheckCircleSolid, BuildingStorefront, BuildingsSolid, ComputerDesktop, FlyingBox } from "@medusajs/icons"
import { config } from "@/config"
import { Table } from "docs-ui"
export const metadata = {
title: `${pageNumber} Introduction - ${config.titleSuffix}`,
title: `${pageNumber} Introduction`,
}
# {pageNumber} Introduction
# {metadata.title}
Medusa is a digital commerce platform with a built-in framework for customization.
@@ -78,12 +79,72 @@ By following this documentation, you'll be able to create custom commerce experi
This documentation is split into the following sections:
1. The main documentation, which is the one you're currently reading. It's recommended to follow the chapters in this documentation to understand the core concepts of Medusa and how to use them.
2. The Product section, which holds the [Commerce](!resources!/commerce-modules) and [Architectural](!resources!/architectural-modules). You can browse those to learn more about Medusa's commerce features and architecture, and find guides specific to each of these modules.
3. The Build section, which holds [recipes](!resources!/recipes), [how-to guides and tutorials](!resources!/how-to-tutorials), [integrations](!resources!/integrations), and [storefront development](!resources!/storefront-development) guides.
4. The [Store](!api!/store) and [Admin](!api!/admin) API references provide a reference to the Medusa application's endpoints and instructions related to authentication, parameter types in requests, and more.
5. The [References section](!resources!/references-overview) that's useful during your development with Medusa to learn about different APIs and how to use them. Its references include the [events reference](!resources!/events-reference), [core workflows reference](!resources!/medusa-workflows-reference), and more.
6. The [User Guide](!user-guide!) introduces you to the Medusa Admin dashboard and helps merchants and store managers understand how to use the dashboard to manage their store.
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Section</Table.HeaderCell>
<Table.HeaderCell className="w-2/3">Description</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[Main Documentation](./page.mdx)
</Table.Cell>
<Table.Cell>
The documentation you're currently reading. It's recommended to follow the chapters in this documentation to understand the core concepts of Medusa and how to use them before jumping into the other sections.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
Product
</Table.Cell>
<Table.Cell>
Documentation for the [Commerce](!resources!/commerce-modules) and [Architectural](!resources!/architectural-modules) Modules. You can browse those to learn more about Medusa's commerce and architectural features, and find guides specific to each of these modules.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
Build
</Table.Cell>
<Table.Cell>
[Recipes](!resources!/recipes), [How-To & Tutorials](!resources!/how-to-tutorials), [Integrations](!resources!/integrations), and [Storefront Development](!resources!/storefront-development) guides. You can follow these guides after you've learned Medusa's core concepts.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[Tools](!resources!/tools)
</Table.Cell>
<Table.Cell>
Guides on how to setup and use Medusa's CLI tools, [JS SDK](!resources!/js-sdk), [Next.js Starter](!resources!/nextjs-starter), and [Medusa UI](!ui!)
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
API Routes References
</Table.Cell>
<Table.Cell>
References of the [Store](!api!/store) and [Admin](!api!/admin) API routes in Medusa. They also include instructions related to authentication, parameter types in requests, and more.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[References](!resources!/references-overview)
</Table.Cell>
<Table.Cell>
Useful during your development with Medusa to learn about different APIs and how to use them. Its references include the [Events Reference](!resources!/events-reference), [Core Workflows Reference](!resources!/medusa-workflows-reference), and more.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[User Guide](!user-guide!)
</Table.Cell>
<Table.Cell>
Guides that introduce merchants and store managers to the Medusa Admin dashboard and helps them understand how to use the dashboard to manage their store.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
To get started, check out the [Installation chapter](./installation/page.mdx).
+1 -1
View File
@@ -2,7 +2,7 @@ export const generatedEditDates = {
"app/learn/fundamentals/scheduled-jobs/page.mdx": "2024-12-09T10:51:40.570Z",
"app/learn/fundamentals/workflows/page.mdx": "2024-12-09T14:45:17.837Z",
"app/learn/deployment/page.mdx": "2025-03-06T09:15:39.707Z",
"app/learn/page.mdx": "2025-02-05T16:04:32.325Z",
"app/learn/page.mdx": "2025-03-11T10:17:39.318Z",
"app/learn/fundamentals/modules/commerce-modules/page.mdx": "2024-12-09T10:46:29.339Z",
"app/learn/fundamentals/workflows/retry-failed-steps/page.mdx": "2024-12-04T07:37:59.823Z",
"app/learn/fundamentals/workflows/workflow-hooks/page.mdx": "2024-12-09T10:44:33.781Z",
File diff suppressed because it is too large Load Diff
@@ -4,6 +4,7 @@ tags:
- cart
- order
- server
- tutorial
---
import { Github, PlaySolid } from "@medusajs/icons"
@@ -4250,5 +4251,3 @@ You've now implemented quote management features in Medusa. There's still more t
If you're new to Medusa, check out the [main documentation](!docs!/learn), where you'll get a more in-depth learning of all the concepts you've used in this guide and more.
To learn more about the commerce features that Medusa provides, check out Medusa's [Commerce Modules](../../../commerce-modules/page.mdx).
You can also check out other guides such as [deployment](../../../deployment/page.mdx) and [integration](../../../integrations/page.mdx) guides.
+1 -7
View File
@@ -6016,19 +6016,13 @@ export const generatedEditDates = {
"references/core_flows/types/core_flows.UpdateClaimShippingMethodValidationStepInput/page.mdx": "2025-02-24T10:48:33.354Z",
"references/core_flows/types/core_flows.UpdateExchangeAddItemValidationStepInput/page.mdx": "2025-03-04T13:33:46.851Z",
"references/core_flows/types/core_flows.UpdateExchangeShippingMethodValidationStepInput/page.mdx": "2025-02-24T10:48:33.582Z",
"references/core_flows/types/core_flows.UpdateOrderEditAddItemValidationStepInput/page.mdx": "2025-02-24T10:48:33.749Z",
"references/core_flows/types/core_flows.UpdateOrderEditItemQuantityValidationStepInput/page.mdx": "2025-02-24T10:48:33.763Z",
"references/core_flows/types/core_flows.UpdateReceiveItemReturnRequestValidationStepInput/page.mdx": "2025-02-24T10:48:34.009Z",
"references/core_flows/types/core_flows.UpdateRequestItemReturnValidationStepInput/page.mdx": "2025-02-24T10:48:34.028Z",
"references/core_flows/types/core_flows.UpdateReturnShippingMethodValidationStepInput/page.mdx": "2025-02-24T10:48:34.037Z",
"references/core_flows/types/core_flows.UpdateReturnValidationStepInput/page.mdx": "2025-02-24T10:48:34.046Z",
"app/examples/guides/quote-management/page.mdx": "2025-03-05T15:11:02.854Z",
"references/core_flows/types/core_flows.UpdateOrderEditAddItemValidationStepInput/page.mdx": "2025-03-04T13:33:47.035Z",
"references/core_flows/types/core_flows.UpdateOrderEditItemQuantityValidationStepInput/page.mdx": "2025-03-04T13:33:47.049Z",
"references/core_flows/types/core_flows.UpdateReceiveItemReturnRequestValidationStepInput/page.mdx": "2025-03-04T13:33:47.307Z",
"references/core_flows/types/core_flows.UpdateRequestItemReturnValidationStepInput/page.mdx": "2025-03-04T13:33:47.327Z",
"references/core_flows/types/core_flows.UpdateReturnShippingMethodValidationStepInput/page.mdx": "2025-03-04T13:33:47.336Z",
"references/core_flows/types/core_flows.UpdateReturnValidationStepInput/page.mdx": "2025-03-04T13:33:47.348Z",
"app/examples/guides/quote-management/page.mdx": "2025-03-11T09:58:19.490Z",
"references/cart/interfaces/cart.CartCreditLineDTO/page.mdx": "2025-03-04T13:33:48.207Z",
"references/cart/interfaces/cart.UpdateLineItemWithoutSelectorDTO/page.mdx": "2025-03-04T13:33:48.254Z",
"references/cart_models/variables/cart_models.CreditLine/page.mdx": "2025-03-04T13:33:56.876Z",
@@ -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"
@@ -1887,6 +1891,22 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.updateShippingMethods/page.mdx",
"pathname": "/references/cart/ICartModuleService/methods/cart.ICartModuleService.updateShippingMethods"
},
{
"filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.upsertLineItemAdjustments/page.mdx",
"pathname": "/references/cart/ICartModuleService/methods/cart.ICartModuleService.upsertLineItemAdjustments"
},
{
"filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.upsertLineItemTaxLines/page.mdx",
"pathname": "/references/cart/ICartModuleService/methods/cart.ICartModuleService.upsertLineItemTaxLines"
},
{
"filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.upsertShippingMethodAdjustments/page.mdx",
"pathname": "/references/cart/ICartModuleService/methods/cart.ICartModuleService.upsertShippingMethodAdjustments"
},
{
"filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.upsertShippingMethodTaxLines/page.mdx",
"pathname": "/references/cart/ICartModuleService/methods/cart.ICartModuleService.upsertShippingMethodTaxLines"
},
{
"filePath": "/www/apps/resources/references/cart/IMessageAggregator/methods/cart.IMessageAggregator.clearMessages/page.mdx",
"pathname": "/references/cart/IMessageAggregator/methods/cart.IMessageAggregator.clearMessages"
@@ -1138,6 +1138,14 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"title": "Implement Custom Line Item Pricing in Medusa",
"path": "https://docs.medusajs.com/resources/examples/guides/custom-item-price",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Implement Quote Management",
"path": "https://docs.medusajs.com/resources/examples/guides/quote-management",
"children": []
}
]
},
@@ -2026,6 +2034,42 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"title": "updateShippingMethods",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/cart/upsertLineItemAdjustments",
"title": "upsertLineItemAdjustments",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/cart/upsertLineItemTaxLines",
"title": "upsertLineItemTaxLines",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/cart/upsertShippingMethodAdjustments",
"title": "upsertShippingMethodAdjustments",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/cart/upsertShippingMethodTaxLines",
"title": "upsertShippingMethodTaxLines",
"description": "",
"children": []
}
]
}
@@ -5011,14 +5055,6 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchInventoryItemLevelsWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "batchProductsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -5952,6 +5988,26 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Server Guides",
"autogenerate_tags": "server+order",
"autogenerate_as_ref": true,
"sort_sidebar": "alphabetize",
"description": "Learn how to use the Order Module in your customizations on the Medusa application server.",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Implement Quote Management",
"path": "https://docs.medusajs.com/resources/examples/guides/quote-management",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
@@ -10094,14 +10150,6 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchPriceListPricesWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "batchProductsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -11382,14 +11430,6 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchLinkProductsToCollectionWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "batchProductsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -293,6 +293,15 @@ const generatedgeneratedHowToTutorialsSidebarSidebar = {
"description": "Learn how to use prices from external systems for products.",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"title": "Quote Management",
"path": "/examples/guides/quote-management",
"description": "Learn how to implement quote management, useful for B2B use cases.",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -95,7 +95,16 @@ const generatedgeneratedRecipesSidebarSidebar = {
"type": "link",
"path": "/recipes/b2b",
"title": "B2B",
"children": []
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/examples/guides/quote-management",
"title": "Example: Quote Management",
"children": []
}
]
},
{
"loaded": true,
@@ -404,6 +404,26 @@ export const slugChanges = [
"newSlug": "/references/cart/updateShippingMethods",
"filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.updateShippingMethods/page.mdx"
},
{
"origSlug": "/references/cart/ICartModuleService/methods/cart.ICartModuleService.upsertLineItemAdjustments",
"newSlug": "/references/cart/upsertLineItemAdjustments",
"filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.upsertLineItemAdjustments/page.mdx"
},
{
"origSlug": "/references/cart/ICartModuleService/methods/cart.ICartModuleService.upsertLineItemTaxLines",
"newSlug": "/references/cart/upsertLineItemTaxLines",
"filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.upsertLineItemTaxLines/page.mdx"
},
{
"origSlug": "/references/cart/ICartModuleService/methods/cart.ICartModuleService.upsertShippingMethodAdjustments",
"newSlug": "/references/cart/upsertShippingMethodAdjustments",
"filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.upsertShippingMethodAdjustments/page.mdx"
},
{
"origSlug": "/references/cart/ICartModuleService/methods/cart.ICartModuleService.upsertShippingMethodTaxLines",
"newSlug": "/references/cart/upsertShippingMethodTaxLines",
"filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.upsertShippingMethodTaxLines/page.mdx"
},
{
"origSlug": "/references/cart/interfaces/cart.ICartModuleService",
"newSlug": "/references/cart",
@@ -78,6 +78,13 @@ While tutorials show you a specific use case, they also help you understand how
description:
"Learn how to use prices from external systems for products.",
},
{
type: "link",
title: "Quote Management",
path: "/examples/guides/quote-management",
description:
"Learn how to implement quote management, useful for B2B use cases.",
},
{
type: "link",
title: "Wishlist Plugin",
-4
View File
@@ -139,10 +139,6 @@ export const eventBus = [
"title": "batchProductVariantsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow"
},
{
"title": "batchProductsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow"
},
{
"title": "createCollectionsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCollectionsWorkflow"
+31 -31
View File
@@ -1,45 +1,45 @@
export * from "./user-guide.js"
export * from "./order.js"
export * from "./fulfillment.js"
export * from "./payment.js"
export * from "./cache.js"
export * from "./how-to.js"
export * from "./server.js"
export * from "./pricing.js"
export * from "./event.js"
export * from "./server.js"
export * from "./product.js"
export * from "./user.js"
export * from "./notification.js"
export * from "./promotion.js"
export * from "./auth.js"
export * from "./workflow.js"
export * from "./api-key.js"
export * from "./stock-location.js"
export * from "./sales-channel.js"
export * from "./currency.js"
export * from "./store.js"
export * from "./tax.js"
export * from "./cart.js"
export * from "./customer.js"
export * from "./region.js"
export * from "./order.js"
export * from "./inventory.js"
export * from "./fulfillment.js"
export * from "./extend-module.js"
export * from "./auth.js"
export * from "./event.js"
export * from "./promotion.js"
export * from "./customer.js"
export * from "./user.js"
export * from "./api-key.js"
export * from "./workflow.js"
export * from "./stock-location.js"
export * from "./notification.js"
export * from "./region.js"
export * from "./cart.js"
export * from "./tutorial.js"
export * from "./concept.js"
export * from "./sales-channel.js"
export * from "./tax.js"
export * from "./store.js"
export * from "./query.js"
export * from "./stripe.js"
export * from "./product-collection.js"
export * from "./product-category.js"
export * from "./checkout.js"
export * from "./storefront.js"
export * from "./currency.js"
export * from "./extend-module.js"
export * from "./example.js"
export * from "./product-category.js"
export * from "./stripe.js"
export * from "./concept.js"
export * from "./remote-query.js"
export * from "./step.js"
export * from "./link.js"
export * from "./remote-query.js"
export * from "./checkout.js"
export * from "./publishable-api-key.js"
export * from "./locking.js"
export * from "./file.js"
export * from "./admin.js"
export * from "./example.js"
export * from "./event-bus.js"
export * from "./js-sdk.js"
export * from "./logger.js"
export * from "./event-bus.js"
export * from "./locking.js"
export * from "./product-collection.js"
export * from "./file.js"
export * from "./js-sdk.js"
export * from "./admin.js"
-4
View File
@@ -163,10 +163,6 @@ export const inventory = [
"title": "batchProductVariantsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow"
},
{
"title": "batchProductsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow"
},
{
"title": "createProductVariantsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductVariantsWorkflow"
-4
View File
@@ -159,10 +159,6 @@ export const link = [
"title": "batchProductVariantsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow"
},
{
"title": "batchProductsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow"
},
{
"title": "createProductVariantsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductVariantsWorkflow"
-4
View File
@@ -151,10 +151,6 @@ export const pricing = [
"title": "batchProductVariantsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow"
},
{
"title": "batchProductsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow"
},
{
"title": "createProductVariantsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductVariantsWorkflow"
-4
View File
@@ -235,10 +235,6 @@ export const product = [
"title": "batchProductVariantsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow"
},
{
"title": "batchProductsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow"
},
{
"title": "createCollectionsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCollectionsWorkflow"
-4
View File
@@ -95,10 +95,6 @@ export const query = [
"title": "batchProductVariantsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow"
},
{
"title": "batchProductsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow"
},
{
"title": "deleteProductVariantsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductVariantsWorkflow"
@@ -451,10 +451,6 @@ export const remoteQuery = [
"title": "batchProductVariantsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow"
},
{
"title": "batchProductsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow"
},
{
"title": "createProductVariantsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductVariantsWorkflow"
+4
View File
@@ -47,6 +47,10 @@ export const server = [
"title": "Implement Custom Line Item Pricing in Medusa",
"path": "https://docs.medusajs.com/resources/examples/guides/custom-item-price"
},
{
"title": "Implement Quote Management",
"path": "https://docs.medusajs.com/resources/examples/guides/quote-management"
},
{
"title": "Build Wishlist Plugin",
"path": "https://docs.medusajs.com/resources/plugins/guides/wishlist"
+4
View File
@@ -19,6 +19,10 @@ export const tutorial = [
"title": "Implement Custom Line Item Pricing in Medusa",
"path": "https://docs.medusajs.com/resources/examples/guides/custom-item-price"
},
{
"title": "Implement Quote Management",
"path": "https://docs.medusajs.com/resources/examples/guides/quote-management"
},
{
"title": "Build Wishlist Plugin",
"path": "https://docs.medusajs.com/resources/plugins/guides/wishlist"