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

docs: revise main docs outline (#10502)

Browse Source
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-12-09 13:54:42 +02:00
1 parent c8cb9b5c1a
commit 0ae98c51eb
141 files changed
+814 -1181
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/app/recipes/b2b/page.mdx
+8 -8
View File
@@ -173,13 +173,13 @@ You can create a B2B module that adds necessary data models to represent a B2B c
<CardList items={[
{
href: "!docs!/learn/basics/modules",
href: "!docs!/learn/fundamentals/modules",
title: "Create Module",
text: "Learn how to create a module in Medusa.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/modules#1-create-data-model",
href: "!docs!/learn/fundamentals/modules#1-create-data-model",
title: "Create Data Models",
text: "Learn how to create data models.",
icon: AcademicCapSolid,
@@ -187,7 +187,7 @@ You can create a B2B module that adds necessary data models to represent a B2B c
]} />
{/* <Card
href="!docs!/learn/advanced-development/modules/module-relationships"
href="!docs!/learn/fundamentals/modules/module-relationships"
title="Create Module Relationships"
text="Learn how to create a relationship between modules."
icon={AcademicCapSolid}
@@ -573,7 +573,7 @@ To implement a more advanced B2B sales flow, add custom data models such as `Com
This provides more granular control of your B2B sales and allows you to build features like privileges, limits, and more.
<Card
href="!docs!/learn/basics/modules#1-create-data-model"
href="!docs!/learn/fundamentals/modules#1-create-data-model"
title="Create a Data Model"
text="Learn how to create a custom data model in a module."
icon={AcademicCapSolid}
@@ -588,7 +588,7 @@ On the frontend clients communicating with your store, such as the storefront, y
The API route can check if the customer has any group with an associated company.
<Card
href="!docs!/learn/basics/api-routes"
href="!docs!/learn/fundamentals/api-routes"
title="Create an API Route"
text="Learn how to create an API Route in Medusa."
icon={AcademicCapSolid}
@@ -724,19 +724,19 @@ The Medusa Admin plugin can be extended to add widgets, new pages, and setting p
<CardList items={[
{
href: "!docs!/learn/advanced-development/admin/widgets",
href: "!docs!/learn/fundamentals/admin/widgets",
title: "Create Admin Widget",
text: "Learn how to add widgets into existing admin pages.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/advanced-development/admin/ui-routes",
href: "!docs!/learn/fundamentals/admin/ui-routes",
title: "Create Admin UI Routes",
text: "Learn how to add new pages to your Medusa Admin.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/advanced-development/admin/ui-routes#create-settings-page",
href: "!docs!/learn/fundamentals/admin/ui-routes#create-settings-page",
title: "Create Admin Setting Page",
text: "Learn how to add new page to the Medusa Admin settings.",
icon: AcademicCapSolid,
www/apps/resources/app/recipes/commerce-automation/page.mdx
+12 -12
View File
@@ -36,13 +36,13 @@ The `inventory-item.updated` event is currently not emitted.
<CardList items={[
{
href: "!docs!/learn/basics/modules",
href: "!docs!/learn/fundamentals/modules",
title: "Create a Module",
text: "Learn how to create a module in Medusa.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/modules#1-create-data-model",
href: "!docs!/learn/fundamentals/modules#1-create-data-model",
title: "Create a Data Model",
text: "Learn how to create a data model.",
icon: AcademicCapSolid,
@@ -51,13 +51,13 @@ The `inventory-item.updated` event is currently not emitted.
<CardList items={[
{
href: "!docs!/learn/basics/api-routes",
href: "!docs!/learn/fundamentals/api-routes",
title: "Create an API Route",
text: "Learn how to create an API route in Medusa.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/events-and-subscribers",
href: "!docs!/learn/fundamentals/events-and-subscribers",
title: "Create a Subscriber",
text: "Learn how to create a subscriber in Medusa.",
icon: AcademicCapSolid,
@@ -409,7 +409,7 @@ Medusa also provides Notification Module Providers that integrate with third-par
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/events-and-subscribers",
href: "!docs!/learn/fundamentals/events-and-subscribers",
title: "Create Subscriber",
text: "Learn how to create a subscriber to handle events.",
icon: AcademicCapSolid,
@@ -428,7 +428,7 @@ To implement that:
- Create a scheduled job that executes the workflow automatically at the specified time pattern.
<Card
href="!docs!/learn/basics/scheduled-jobs"
href="!docs!/learn/fundamentals/scheduled-jobs"
title="Create a Scheduled Job"
text="Learn how to create a scheduled job in Medusa."
icon={AcademicCapSolid}
@@ -654,7 +654,7 @@ The `order.placed` event is currently not emitted.
</Note>
<Card
href="!docs!/learn/basics/events-and-subscribers"
href="!docs!/learn/fundamentals/events-and-subscribers"
title="Create a Subscriber"
text="Learn how to create a subscriber in Medusa."
icon={AcademicCapSolid}
@@ -662,7 +662,7 @@ The `order.placed` event is currently not emitted.
{/* <CardList items={[
{
href: "!docs!/learn/basics/events-and-subscribers",
href: "!docs!/learn/fundamentals/events-and-subscribers",
title: "Create a Subscriber",
text: "Learn how to create a subscriber in Medusa.",
icon: AcademicCapSolid,
@@ -695,7 +695,7 @@ Medusa's commerce features are geared towards automating RMA flows and ensuring
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/events-and-subscribers",
href: "!docs!/learn/fundamentals/events-and-subscribers",
title: "Create a Subscriber",
text: "Learn how to create a subscriber in Medusa.",
icon: AcademicCapSolid,
@@ -738,7 +738,7 @@ The `order.placed` event is currently not emitted.
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/events-and-subscribers",
href: "!docs!/learn/fundamentals/events-and-subscribers",
title: "Create a Subscriber",
text: "Learn how to create a subscriber in Medusa.",
icon: AcademicCapSolid,
@@ -840,13 +840,13 @@ You can also create a scheduled job that checks whether the number of new produc
<CardList items={[
{
href: "!docs!/learn/basics/events-and-subscribers",
href: "!docs!/learn/fundamentals/events-and-subscribers",
title: "Create a Subscriber",
text: "Learn how to create a subscriber in Medusa.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/scheduled-jobs",
href: "!docs!/learn/fundamentals/scheduled-jobs",
title: "Scheduled Jobs",
text: "Learn how to create a scheduled job in Medusa.",
icon: AcademicCapSolid,
www/apps/resources/app/recipes/digital-products/examples/standard/page.mdx
+15 -15
View File
@@ -174,7 +174,7 @@ class DigitalProductModuleService extends MedusaService({
export default DigitalProductModuleService
```
The service extends the [service factory](!docs!/learn/advanced-development/modules/service-factory), which provides basic data-management features.
The service extends the [service factory](!docs!/learn/fundamentals/modules/service-factory), which provides basic data-management features.
### Create Module Definition
@@ -208,8 +208,8 @@ module.exports = defineConfig({
### Further Reads
- [How to Create a Module](!docs!/learn/basics/modules)
- [How to Create a Data Model](!docs!/learn/basics/modules#1-create-data-model)
- [How to Create a Module](!docs!/learn/fundamentals/modules)
- [How to Create a Data Model](!docs!/learn/fundamentals/modules#1-create-data-model)
---
@@ -268,7 +268,7 @@ This defines a link between `DigitalProductOrder` and the Order Module’s `Orde
### Further Read
- [How to Define Module Links](!docs!/learn/advanced-development/module-links)
- [How to Define Module Links](!docs!/learn/fundamentals/module-links)
---
@@ -376,8 +376,8 @@ Make sure to replace `{token}` with the JWT token you retrieved.
### Further Reads
- [How to Create an API Route](!docs!/learn/basics/api-routes)
- [Learn more about Query](!docs!/learn/advanced-development/module-links/query)
- [How to Create an API Route](!docs!/learn/fundamentals/api-routes)
- [Learn more about Query](!docs!/learn/fundamentals/module-links/query)
---
@@ -626,9 +626,9 @@ You’ll test out the workflow in the next section.
### Further Reads
- [How to Create a Workflow](!docs!/learn/basics/workflows)
- [What is the Compensation Function](!docs!/learn/advanced-development/workflows/compensation-function)
- [Learn more about the remote link function](!docs!/learn/advanced-development/module-links/remote-link)
- [How to Create a Workflow](!docs!/learn/fundamentals/workflows)
- [What is the Compensation Function](!docs!/learn/fundamentals/workflows/compensation-function)
- [Learn more about the remote link function](!docs!/learn/fundamentals/module-links/remote-link)
---
@@ -727,7 +727,7 @@ This adds a validation middleware to ensure that the body of `POST` requests sen
### Further Read
- [How to Create a Middleware](!docs!/learn/advanced-development/api-routes/middlewares)
- [How to Create a Middleware](!docs!/learn/fundamentals/api-routes/middlewares)
---
@@ -1062,8 +1062,8 @@ Once you log in, you’ll find a new sidebar item, “Digital Products.” If yo
### Further Reads
- [How to Create UI Routes](!docs!/learn/advanced-development/admin/ui-routes)
- [How to Create Admin Widgets](!docs!/learn/advanced-development/admin/widgets)
- [How to Create UI Routes](!docs!/learn/fundamentals/admin/ui-routes)
- [How to Create Admin Widgets](!docs!/learn/fundamentals/admin/widgets)
---
@@ -1836,7 +1836,7 @@ In a later step, you’ll add an API route to allow customers to view and downlo
### Further Read
- [Conditions in Workflows with When-Then](!docs!/learn/advanced-development/workflows/conditions)
- [Conditions in Workflows with When-Then](!docs!/learn/fundamentals/workflows/conditions)
---
@@ -2319,7 +2319,7 @@ You’ll test out these API routes in the next step.
### Further Reads
- [What are protected API routes](!docs!/learn/advanced-development/api-routes/protected-routes)
- [What are protected API routes](!docs!/learn/fundamentals/api-routes/protected-routes)
---
@@ -2746,4 +2746,4 @@ Aside from customizing the Next.js Starter storefront, you can also create a cus
### Admin Development
In this recipe, you learned how to customize the admin with UI routes. You can also do further customization using widgets. Learn more in [this documentation](!docs!/learn/advanced-development/admin).
In this recipe, you learned how to customize the admin with UI routes. You can also do further customization using widgets. Learn more in [this documentation](!docs!/learn/fundamentals/admin).
www/apps/resources/app/recipes/digital-products/page.mdx
+10 -10
View File
@@ -49,7 +49,7 @@ Your custom features and functionalities are implemented inside modules. The mod
The module will hold your custom data models and the service implementing digital-product-related features.
<Card
href="!docs!/learn/basics/modules"
href="!docs!/learn/fundamentals/modules"
title="How to Create a Module"
text="Learn how to create a module."
icon={AcademicCapSolid}
@@ -63,13 +63,13 @@ Then, you can link your custom data model to data models from other modules. For
<CardList itemsPerRow={2} items={[
{
href: "!docs!/learn/basics/modules#1-create-data-model",
href: "!docs!/learn/fundamentals/modules#1-create-data-model",
title: "How to Create a Data Model",
text: "Learn how to create a data model.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/advanced-development/module-links",
href: "!docs!/learn/fundamentals/module-links",
title: "Module Links",
text: "Learn how to link data models of different modules.",
icon: AcademicCapSolid,
@@ -83,7 +83,7 @@ Your module’s main service holds data-management and other related features. T
Medusa facilitates implementing data-management features using the service factory. Your module's main service can extend this service factory, and it generates data-management methods for your data models.
<Card
href="!docs!/learn/advanced-development/modules/service-factory"
href="!docs!/learn/fundamentals/modules/service-factory"
title="Service Factory"
text="Learn about the service factory and how to use it."
icon={AcademicCapSolid}
@@ -98,7 +98,7 @@ API routes expose your features to external applications, such as the admin dash
You can create custom API routes that allow merchants to list and create digital products. In these API routes, you resolve the Digital Product Module’s main service to use its data-management features.
<Card
href="!docs!/learn/basics/api-routes"
href="!docs!/learn/fundamentals/api-routes"
title="API Routes"
text="Learn how to create an API route."
icon={AcademicCapSolid}
@@ -113,7 +113,7 @@ Your use case most likely has flows, such as creating digital products, that req
Create workflows to implement these flows, then utilize these workflows in other resources, such as an API route.
<Card
href="!docs!/learn/basics/workflows"
href="!docs!/learn/fundamentals/workflows"
title="Workflows"
text="Learn how to create a workflow."
icon={AcademicCapSolid}
@@ -129,13 +129,13 @@ Use the remote link to create a link between two records, and use Query to fetch
<CardList itemsPerRow={2} items={[
{
href: "!docs!/learn/advanced-development/module-links/remote-link",
href: "!docs!/learn/fundamentals/module-links/remote-link",
title: "How to Use the Remote Link",
text: "Learn how to link data models of different modules.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/advanced-development/module-links/query",
href: "!docs!/learn/fundamentals/module-links/query",
title: "How to Use Query",
text: "Learn how to fetch data across modules with Medusa's Query.",
icon: AcademicCapSolid,
@@ -152,13 +152,13 @@ In your customizations, you send requests to the API routes you created to creat
<CardList items={[
{
href: "!docs!/learn/advanced-development/admin/widgets",
href: "!docs!/learn/fundamentals/admin/widgets",
title: "Create a Widget",
text: "Learn how to create a widget in the Medusa Admin.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/advanced-development/admin/ui-routes",
href: "!docs!/learn/fundamentals/admin/ui-routes",
title: "Create UI Route",
text: "Learn how to create a UI route in the Medusa Admin.",
icon: AcademicCapSolid,
www/apps/resources/app/recipes/integrate-ecommerce-stack/page.mdx
+4 -4
View File
@@ -28,7 +28,7 @@ To integrate an external system, such as an ERP, into your Medusa application, c
Then, resolve the module's main service in other resources, such as API routes or workflows, to perform actions in the external system.
<Card
href="!docs!/learn/basics/modules"
href="!docs!/learn/fundamentals/modules"
title="Create a Module"
text="Learn how to create a module in Medusa."
icon={AcademicCapSolid}
@@ -101,7 +101,7 @@ export const serviceHighlights = [
<Note title="Tip">
You can store the product's ID in the external system using the `metadata` property of the `Product` data model in the Product Module. Alternatively, you can create a [data model](!docs!/learn/basics/modules#1-create-data-model) in your module to store data related to the external system.
You can store the product's ID in the external system using the `metadata` property of the `Product` data model in the Product Module. Alternatively, you can create a [data model](!docs!/learn/fundamentals/modules#1-create-data-model) in your module to store data related to the external system.
</Note>
@@ -150,7 +150,7 @@ Workflows can be executed from anywhere. So, taking the workflow described above
Workflows guarantee data consistency through their compensation feature. You can provide a compensation function to steps that roll back the actions of that step. Then, if an error occurs in any step, the actions of previous steps are rolled back using their compensation function.
<Card
href="!docs!/learn/basics/workflows"
href="!docs!/learn/fundamentals/workflows"
title="Workflows"
text="Learn more about Workflows and how to create them."
icon={AcademicCapSolid}
@@ -295,7 +295,7 @@ You can provide webhook listeners that your external systems call when their dat
For example, suppose an administrator changes the product data in the ERP system. The system then sends a request to the webhook you define in your Medusa application, which updates the product data in the application.
<Card
href="!docs!/learn/basics/api-routes"
href="!docs!/learn/fundamentals/api-routes"
title="Create an API Route"
text="Learn how to create an API Route in Medusa."
icon={AcademicCapSolid}
www/apps/resources/app/recipes/marketplace/examples/restaurant-delivery/page.mdx
+13 -13
View File
@@ -140,7 +140,7 @@ class RestaurantModuleService extends MedusaService({
export default RestaurantModuleService
```
The service extends the [service factory](!docs!/learn/advanced-development/modules/service-factory), which provides basic data-management features.
The service extends the [service factory](!docs!/learn/fundamentals/modules/service-factory), which provides basic data-management features.
### Create Restaurant Module Definition
@@ -174,8 +174,8 @@ module.exports = defineConfig({
### Further Reads
- [How to Create a Module](!docs!/learn/basics/modules)
- [How to Create a Data Model](!docs!/learn/basics/modules#1-create-data-model)
- [How to Create a Module](!docs!/learn/fundamentals/modules)
- [How to Create a Data Model](!docs!/learn/fundamentals/modules#1-create-data-model)
---
@@ -284,7 +284,7 @@ class DeliveryModuleService extends MedusaService({
export default DeliveryModuleService
```
The service extends the [service factory](!docs!/learn/advanced-development/modules/service-factory), which provides basic data-management features.
The service extends the [service factory](!docs!/learn/fundamentals/modules/service-factory), which provides basic data-management features.
### Create Delivery Module Definition
@@ -415,7 +415,7 @@ This defines a link between the Delivery Module’s `delivery` data model and th
### Further Reads
- [How to Define Links](!docs!/learn/advanced-development/module-links)
- [How to Define Links](!docs!/learn/fundamentals/module-links)
---
@@ -625,15 +625,15 @@ The API route creates a restaurant and returns it.
<Note>
If you’re calling this API route from a frontend client, make sure to set the [CORS middleware](!docs!/learn/advanced-development/api-routes/cors) on it since it’s not under the `/store` or `/admin` route prefixes.
If you’re calling this API route from a frontend client, make sure to set the [CORS middleware](!docs!/learn/fundamentals/api-routes/cors) on it since it’s not under the `/store` or `/admin` route prefixes.
</Note>
### Further Reads
- [How to Create a Workflow](!docs!/learn/basics/workflows)
- [What is a Compensation Function](!docs!/learn/advanced-development/workflows/compensation-function)
- [How to Create an API route](!docs!/learn/basics/api-routes)
- [How to Create a Workflow](!docs!/learn/fundamentals/workflows)
- [What is a Compensation Function](!docs!/learn/fundamentals/workflows/compensation-function)
- [How to Create an API route](!docs!/learn/fundamentals/api-routes)
---
@@ -704,7 +704,7 @@ This returns the list of restaurants in the response.
### Further Reads
- [What is and how to use it](!docs!/learn/advanced-development/module-links/query)
- [What is and how to use it](!docs!/learn/fundamentals/module-links/query)
- [How to Retrieve Prices for Product Variants](../../../../commerce-modules/product/guides/price/page.mdx)
---
@@ -1561,7 +1561,7 @@ In this step, you’ll create the workflow that handles the different stages of
For example, when a restaurant finishes preparing the order’s items, this workflow creates a fulfillment for the order.
This workflow will be a [long-running workflow](!docs!/learn/advanced-development/workflows/long-running-workflow) that runs asynchronously in the background. Its async steps only succeed once an outside action sets its status, allowing the workflow to move to the next step.
This workflow will be a [long-running workflow](!docs!/learn/fundamentals/workflows/long-running-workflow) that runs asynchronously in the background. Its async steps only succeed once an outside action sets its status, allowing the workflow to move to the next step.
API routes that perform actions related to the delivery, which you’ll create later, will trigger the workflow to move to the next step.
@@ -2082,7 +2082,7 @@ In the next steps, you’ll execute the workflow and see it in action as you add
### Further Reads
- [Long-Running Workflows](!docs!/learn/advanced-development/workflows/long-running-workflow)
- [Long-Running Workflows](!docs!/learn/fundamentals/workflows/long-running-workflow)
---
@@ -3478,7 +3478,7 @@ The next steps of this example depend on your use case. This section provides so
### Admin Development
The Medusa Admin is extendable, allowing you to add widgets to existing pages or create new pages. Learn more about it in [this documentation](!docs!/learn/advanced-development/admin).
The Medusa Admin is extendable, allowing you to add widgets to existing pages or create new pages. Learn more about it in [this documentation](!docs!/learn/fundamentals/admin).
### Storefront Development
www/apps/resources/app/recipes/marketplace/examples/vendors/page.mdx
Vendored
+13 -13
View File
@@ -120,7 +120,7 @@ class MarketplaceModuleService extends MedusaService({
export default MarketplaceModuleService
```
The service extends the [service factory](!docs!/learn/advanced-development/modules/service-factory), which provides basic data-management features.
The service extends the [service factory](!docs!/learn/fundamentals/modules/service-factory), which provides basic data-management features.
### Create Module Definition
@@ -154,8 +154,8 @@ module.exports = defineConfig({
### Further Reads
- [How to Create a Module](!docs!/learn/basics/modules)
- [How to Create Data Models](!docs!/learn/basics/modules#1-create-data-model)
- [How to Create a Module](!docs!/learn/fundamentals/modules)
- [How to Create Data Models](!docs!/learn/fundamentals/modules#1-create-data-model)
---
@@ -213,7 +213,7 @@ This adds a list link between the `Vendor` and `Order` data models, indicating t
### Further Read
- [How to Define Module Links](!docs!/learn/advanced-development/module-links)
- [How to Define Module Links](!docs!/learn/fundamentals/module-links)
---
@@ -350,10 +350,10 @@ You return the created vendor admin.
### Further Read
- [How to Create a Workflow](!docs!/learn/basics/workflows)
- [How to Create a Workflow](!docs!/learn/fundamentals/workflows)
- [What is an Actor Type](../../../../commerce-modules/auth/auth-identity-and-actor-types/page.mdx)
- [How to Create an Actor Type](../../../../commerce-modules/auth/create-actor-type/page.mdx)
- [What is a Compensation Function](!docs!/learn/advanced-development/workflows/compensation-function)
- [What is a Compensation Function](!docs!/learn/fundamentals/workflows/compensation-function)
---
@@ -527,7 +527,7 @@ This route is available because you created the `vendor` actor type previously.
<Note>
Don't include a trailing slash at the end of the URL. Learn more [here](!docs!/learn/advanced-development/api-routes/middlewares).
Don't include a trailing slash at the end of the URL. Learn more [here](!docs!/learn/fundamentals/api-routes/middlewares).
</Note>
@@ -563,8 +563,8 @@ Use this token in the header of later requests that require authentication.
### Further Reads
- [How to Create an API route](!docs!/learn/basics/api-routes)
- [How to Create a Middleware](!docs!/learn/advanced-development/api-routes/middlewares)
- [How to Create an API route](!docs!/learn/fundamentals/api-routes)
- [How to Create a Middleware](!docs!/learn/fundamentals/api-routes/middlewares)
- [Learn more about the /auth route](../../../../commerce-modules/auth/authentication-route/page.mdx)
---
@@ -792,8 +792,8 @@ curl 'http://localhost:9000/vendors/products' \
### Further Reads
- [How to use Query](!docs!/learn/advanced-development/module-links/query)
- [How to use the Remote Link](!docs!/learn/advanced-development/module-links/remote-link)
- [How to use Query](!docs!/learn/fundamentals/module-links/query)
- [How to use the Remote Link](!docs!/learn/fundamentals/module-links/remote-link)
---
@@ -1392,7 +1392,7 @@ For example, you can link sales channels to vendors or other settings.
<Note>
[Learn more about module links](!docs!/learn/advanced-development/module-links).
[Learn more about module links](!docs!/learn/fundamentals/module-links).
</Note>
@@ -1404,6 +1404,6 @@ You can also create a custom storefront. Check out the [Storefront Development](
### Admin Development
The Medusa Admin is extendable, allowing you to add widgets to existing pages or create new pages. Learn more about it in [this documentation](!docs!/learn/advanced-development/admin).
The Medusa Admin is extendable, allowing you to add widgets to existing pages or create new pages. Learn more about it in [this documentation](!docs!/learn/fundamentals/admin).
If your use case requires bigger customizations to the admin, such as showing different products and orders based on the logged-in vendor, use the [admin API routes](!api!/admin) to build a custom admin.
www/apps/resources/app/recipes/marketplace/page.mdx
+6 -6
View File
@@ -35,13 +35,13 @@ You can create a marketplace module that implements data models for vendors, the
<CardList items={[
{
href: "!docs!/learn/basics/modules",
href: "!docs!/learn/fundamentals/modules",
title: "Create a Module",
text: "Learn how to create a module.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/modules#1-create-data-model",
href: "!docs!/learn/fundamentals/modules#1-create-data-model",
title: "Create Data Models",
text: "Create data models in the module.",
icon: AcademicCapSolid,
@@ -57,7 +57,7 @@ Since a vendor has products, orders, and other models based on your use case, de
For example, if you defined a vendor data model in a marketplace module, you can define a module link between the vendor and the Product Module's product data model.
<Card
href="!docs!/learn/advanced-development/module-links"
href="!docs!/learn/fundamentals/module-links"
title="Define a Module Link"
text="Learn how to define a module link."
icon={AcademicCapSolid}
@@ -86,13 +86,13 @@ If you provide vendor or sellers with custom features, or a different way of man
<CardList items={[
{
href: "!docs!/learn/basics/api-routes",
href: "!docs!/learn/fundamentals/api-routes",
title: "Create API Routes",
text: "Learn how to create an API Route in Medusa.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/advanced-development/api-routes/protected-routes",
href: "!docs!/learn/fundamentals/api-routes/protected-routes",
title: "Protect Routes",
text: "Learn how to guard routes to allow authenticated users only.",
icon: AcademicCapSolid,
@@ -108,7 +108,7 @@ If your use case allows a customer's orders to have items from different vendors
If your flow requires different steps, such as creating a parent order then creating a child order, create a workflow and execute it from the API route.
<Card
href="!docs!/learn/basics/workflows"
href="!docs!/learn/fundamentals/workflows"
title="Create a Workflow"
text="Learn how to create a workflow in Medusa."
icon={AcademicCapSolid}
www/apps/resources/app/recipes/multi-region-store/page.mdx
+1 -1
View File
@@ -157,7 +157,7 @@ By integrating a third-party Content Management Systems (CMS), you benefit from
To integrate a third-party system, create a custom module whose main service connects to that third-party service.
<Card
href="!docs!/learn/basics/modules"
href="!docs!/learn/fundamentals/modules"
title="Create a Module"
text="Learn how to create a module in Medusa."
icon={AcademicCapSolid}
www/apps/resources/app/recipes/omnichannel/page.mdx
+3 -3
View File
@@ -52,7 +52,7 @@ Another channel that attracts customer sales is social media. You can create a c
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/modules",
href: "!docs!/learn/fundamentals/modules",
title: "Create a Module",
text: "Learn how to create a module.",
icon: AcademicCapSolid,
@@ -73,13 +73,13 @@ Medusa’s architecture also makes it easier to integrate any third-party servic
<CardList itemsPerRow={2} items={[
{
href: "!docs!/learn/basics/modules",
href: "!docs!/learn/fundamentals/modules",
title: "Create a Module",
text: "Learn how to create a module.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/api-routes",
href: "!docs!/learn/fundamentals/api-routes",
title: "Create an API Route",
text: "Learn how to create an API route.",
icon: AcademicCapSolid,
www/apps/resources/app/recipes/oms/page.mdx
+5 -5
View File
@@ -43,13 +43,13 @@ For example, you can support importing orders into Medusa through a custom API R
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/api-routes",
href: "!docs!/learn/fundamentals/api-routes",
title: "Create API Route",
text: "Learn how to create a custom API Route.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/scheduled-jobs",
href: "!docs!/learn/fundamentals/scheduled-jobs",
title: "Create Scheduled Jobs",
text: "Learn how to create a scheduled job.",
icon: AcademicCapSolid,
@@ -82,7 +82,7 @@ Emitting of event `order.fulfillment_created` isn't implemented yet.
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/events-and-subscribers",
href: "!docs!/learn/fundamentals/events-and-subscribers",
title: "Create a Subscriber",
text: "Learn about create a subscriber",
icon: AcademicCapSolid,
@@ -111,7 +111,7 @@ Emitting of event `order.payment_captured` isn't implemented yet.
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/events-and-subscribers",
href: "!docs!/learn/fundamentals/events-and-subscribers",
title: "Create a Subscriber",
text: "Learn about create a subscriber",
icon: AcademicCapSolid,
@@ -179,7 +179,7 @@ Emitting of event `order.return_requested` isn't implemented yet.
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/events-and-subscribers",
href: "!docs!/learn/fundamentals/events-and-subscribers",
title: "Create a Subscriber",
text: "Learn about create a subscriber",
icon: AcademicCapSolid,
www/apps/resources/app/recipes/personalized-products/page.mdx
+4 -4
View File
@@ -48,13 +48,13 @@ In more complex cases, you can create a custom module that stores and manages th
<CardList items={[
{
href: "!docs!/learn/basics/modules",
href: "!docs!/learn/fundamentals/modules",
title: "Create a Module",
text: "Learn how to create a module.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/modules#1-create-data-model",
href: "!docs!/learn/fundamentals/modules#1-create-data-model",
title: "Create a Data Model",
text: "Learn how to create a data model.",
icon: AcademicCapSolid,
@@ -98,13 +98,13 @@ If you store the personalized data using a custom module:
<CardList items={[
{
href: "!docs!/learn/basics/api-routes",
href: "!docs!/learn/fundamentals/api-routes",
title: "Create API Route",
text: "Learn how to create an API route.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/events-and-subscribers",
href: "!docs!/learn/fundamentals/events-and-subscribers",
title: "Create a Subscriber",
text: "Learn how to create a subscriber.",
icon: AcademicCapSolid,
www/apps/resources/app/recipes/pos/page.mdx
+2 -2
View File
@@ -60,7 +60,7 @@ To search through product variants by their barcode, create a custom API Route a
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/api-routes",
href: "!docs!/learn/fundamentals/api-routes",
title: "Create API Route",
text: "Learn how to create an API Route.",
icon: AcademicCapSolid,
@@ -167,7 +167,7 @@ You can also create custom modules to provide features for a better customer exp
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/modules",
href: "!docs!/learn/fundamentals/modules",
title: "Create a Module",
text: "Learn how to create a module.",
icon: AcademicCapSolid,
www/apps/resources/app/recipes/subscriptions/examples/standard/page.mdx
+10 -10
View File
@@ -172,9 +172,9 @@ module.exports = defineConfig({
### Further Read
- [How to Create a Module](!docs!/learn/basics/modules)
- [How to Create a Data Model](!docs!/learn/basics/modules#1-create-data-model)
- [Learn more about the service factory](!docs!/learn/advanced-development/modules/service-factory).
- [How to Create a Module](!docs!/learn/fundamentals/modules)
- [How to Create a Data Model](!docs!/learn/fundamentals/modules#1-create-data-model)
- [Learn more about the service factory](!docs!/learn/fundamentals/modules/service-factory).
---
@@ -257,7 +257,7 @@ This defines a list link to the `Order` data model since a subscription has mult
### Further Reads
- [How to Define a Link](!docs!/learn/advanced-development/module-links)
- [How to Define a Link](!docs!/learn/fundamentals/module-links)
---
@@ -670,9 +670,9 @@ The workflow returns the created subscription and order.
### Further Reads
- [How to Create a Workflow](!docs!/learn/basics/workflows)
- [Learn more about the compensation function](!docs!/learn/advanced-development/workflows/compensation-function)
- [How to use the Remote Link](!docs!/learn/advanced-development/module-links/remote-link)
- [How to Create a Workflow](!docs!/learn/fundamentals/workflows)
- [Learn more about the compensation function](!docs!/learn/fundamentals/workflows/compensation-function)
- [How to use the Remote Link](!docs!/learn/fundamentals/module-links/remote-link)
---
@@ -986,7 +986,7 @@ npm run dev
### Further Reads
- [How to Create an API Route](!docs!/learn/basics/api-routes)
- [How to Create an API Route](!docs!/learn/fundamentals/api-routes)
---
@@ -1465,7 +1465,7 @@ To view a subscription’s details, click on its ID, which opens the subscriptio
### Further Reads
- [How to Create UI Routes](!docs!/learn/advanced-development/admin/ui-routes)
- [How to Create UI Routes](!docs!/learn/fundamentals/admin/ui-routes)
---
@@ -2008,7 +2008,7 @@ This loops over the returned subscriptions and executes the `createSubscriptionO
### Further Reads
- [How to Create a Scheduled Job](!docs!/learn/basics/scheduled-jobs)
- [How to Create a Scheduled Job](!docs!/learn/fundamentals/scheduled-jobs)
---
www/apps/resources/app/recipes/subscriptions/page.mdx
+7 -7
View File
@@ -33,13 +33,13 @@ You can link the subscription data model to models of other modules, such as the
<CardList items={[
{
href: "!docs!/learn/basics/modules",
href: "!docs!/learn/fundamentals/modules",
title: "Create a Module",
text: "Learn how to create a module.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/modules#1-create-data-model",
href: "!docs!/learn/fundamentals/modules#1-create-data-model",
title: "Create a Data Model",
text: "Learn how to create a data model.",
icon: AcademicCapSolid,
@@ -57,7 +57,7 @@ For example, you can link the subscription data model to the Order Module's `Ord
If you want to create subscriptions on the product level, you can link the subscription data model to the Product Module's `Product` data model.
<Card
href="!docs!/learn/advanced-development/module-links"
href="!docs!/learn/fundamentals/module-links"
title="Define a Module Link"
text="Learn how to define a module link."
icon={AcademicCapSolid}
@@ -81,13 +81,13 @@ Implementing the logic depends on your use case, but you'll mainly implement the
<CardList itemsPerRow={2} items={[
{
href: "!docs!/learn/basics/api-routes",
href: "!docs!/learn/fundamentals/api-routes",
title: "Create an API Route",
text: "Learn how to create an API route.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/basics/scheduled-jobs",
href: "!docs!/learn/fundamentals/scheduled-jobs",
title: "Create a Scheduled Job",
text: "Learn how to create a scheduled job.",
icon: AcademicCapSolid,
@@ -119,13 +119,13 @@ Extend the Medusa Admin to add widgets to existing pages or add new pages.
<CardList items={[
{
href: "!docs!/learn/advanced-development/admin/widgets",
href: "!docs!/learn/fundamentals/admin/widgets",
title: "Create Admin Widget",
text: "Learn how to add widgets into existing admin pages.",
icon: AcademicCapSolid,
},
{
href: "!docs!/learn/advanced-development/admin/ui-routes",
href: "!docs!/learn/fundamentals/admin/ui-routes",
title: "Create Admin UI Routes",
text: "Learn how to add new pages to your Medusa Admin.",
icon: AcademicCapSolid,