Skip to content

Commit

Permalink
docs: add workflow and js sdk reference pages for commerce modules (#…
Browse files Browse the repository at this point in the history
…10898)

* docs: add workflow and js sdk reference pages for commerce modules

* resolve build errors
  • Loading branch information
shahednasser authored Jan 9, 2025
1 parent 3fec01a commit 44706ef
Show file tree
Hide file tree
Showing 80 changed files with 9,207 additions and 8,213 deletions.
15 changes: 15 additions & 0 deletions www/apps/resources/app/commerce-modules/api-key/js-sdk/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `API Key JS SDK Methods`,
}

# {metadata.title}

The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.

Use the following methods or properties to send requests to API key related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.

The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).

<ChildDocs type="item" />
2 changes: 1 addition & 1 deletion www/apps/resources/app/commerce-modules/api-key/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -155,4 +155,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor

---

<CommerceModuleSections name="API Key" />
<CommerceModuleSections />
15 changes: 15 additions & 0 deletions www/apps/resources/app/commerce-modules/api-key/workflows/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `API Key Workflows`,
}

# {metadata.title}

[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.

When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage API keys and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.

The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).

<ChildDocs type="item" defaultItemsPerRow={2} />
15 changes: 15 additions & 0 deletions www/apps/resources/app/commerce-modules/auth/js-sdk/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `Auth JS SDK Methods`,
}

# {metadata.title}

The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.

Use the following methods or properties to send requests to authentication related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.

The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).

<ChildDocs type="item" onlyTopLevel />
2 changes: 1 addition & 1 deletion www/apps/resources/app/commerce-modules/auth/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -143,4 +143,4 @@ Medusa provides the following authentication providers out-of-the-box. You can u

---

<CommerceModuleSections name="Auth" />
<CommerceModuleSections />
15 changes: 15 additions & 0 deletions www/apps/resources/app/commerce-modules/auth/workflows/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `Auth Workflows`,
}

# {metadata.title}

[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.

When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to use authentication-related features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.

The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).

<ChildDocs type="item" defaultItemsPerRow={2} />
15 changes: 15 additions & 0 deletions www/apps/resources/app/commerce-modules/cart/js-sdk/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `Cart JS SDK Methods`,
}

# {metadata.title}

The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.

Use the following methods or properties to send requests to cart related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.

The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).

<ChildDocs type="item" />
2 changes: 1 addition & 1 deletion www/apps/resources/app/commerce-modules/cart/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -167,4 +167,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor

---

<CommerceModuleSections name="Cart" />
<CommerceModuleSections />
15 changes: 15 additions & 0 deletions www/apps/resources/app/commerce-modules/cart/workflows/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `Cart Workflows`,
}

# {metadata.title}

[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.

When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage carts and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.

The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).

<ChildDocs type="item" defaultItemsPerRow={2} />
15 changes: 15 additions & 0 deletions www/apps/resources/app/commerce-modules/currency/js-sdk/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `Currency JS SDK Methods`,
}

# {metadata.title}

The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.

Use the following methods or properties to send requests to currency related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.

The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).

<ChildDocs type="item" />
2 changes: 1 addition & 1 deletion www/apps/resources/app/commerce-modules/currency/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -163,4 +163,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor

---

<CommerceModuleSections name="Currency" />
<CommerceModuleSections />
15 changes: 15 additions & 0 deletions www/apps/resources/app/commerce-modules/customer/js-sdk/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `Customer JS SDK Methods`,
}

# {metadata.title}

The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.

Use the following methods or properties to send requests to customer related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.

The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).

<ChildDocs type="item" />
2 changes: 1 addition & 1 deletion www/apps/resources/app/commerce-modules/customer/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -156,4 +156,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor

---

<CommerceModuleSections name="Customer" />
<CommerceModuleSections />
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `Customer Workflows`,
}

# {metadata.title}

[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.

When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage customers and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.

The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).

<ChildDocs type="item" defaultItemsPerRow={2} />
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `Fulfillment JS SDK Methods`,
}

# {metadata.title}

The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.

Use the following methods or properties to send requests to fulfillment related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.

The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).

<ChildDocs type="item" />
Original file line number Diff line number Diff line change
Expand Up @@ -178,4 +178,4 @@ The Fulfillment Module accepts options for further configurations. Refer to [thi

---

<CommerceModuleSections name="Fulfillment" />
<CommerceModuleSections />
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `Fulfillment Workflows`,
}

# {metadata.title}

[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.

When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage fulfillments and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.

The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).

<ChildDocs type="item" defaultItemsPerRow={2} />
15 changes: 15 additions & 0 deletions www/apps/resources/app/commerce-modules/inventory/js-sdk/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `Inventory JS SDK Methods`,
}

# {metadata.title}

The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.

Use the following methods or properties to send requests to inventory related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.

The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).

<ChildDocs type="item" />
2 changes: 1 addition & 1 deletion www/apps/resources/app/commerce-modules/inventory/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -159,4 +159,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor

---

<CommerceModuleSections name="Inventory" />
<CommerceModuleSections />
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `Inventory Workflows`,
}

# {metadata.title}

[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.

When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage inventory and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.

The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).

<ChildDocs type="item" defaultItemsPerRow={2} />
15 changes: 15 additions & 0 deletions www/apps/resources/app/commerce-modules/order/js-sdk/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `Order JS SDK Methods`,
}

# {metadata.title}

The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.

Use the following methods or properties to send requests to order related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.

The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).

<ChildDocs type="item" />
2 changes: 1 addition & 1 deletion www/apps/resources/app/commerce-modules/order/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -171,4 +171,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor

---

<CommerceModuleSections name="Order" />
<CommerceModuleSections />
15 changes: 15 additions & 0 deletions www/apps/resources/app/commerce-modules/order/workflows/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `Order Workflows`,
}

# {metadata.title}

[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.

When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage orders and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.

The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).

<ChildDocs type="item" defaultItemsPerRow={2} />
15 changes: 15 additions & 0 deletions www/apps/resources/app/commerce-modules/payment/js-sdk/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `Payment JS SDK Methods`,
}

# {metadata.title}

The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.

Use the following methods or properties to send requests to payment related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.

The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).

<ChildDocs type="item" />
2 changes: 1 addition & 1 deletion www/apps/resources/app/commerce-modules/payment/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -172,4 +172,4 @@ Medusa provides the following payment providers out-of-the-box. You can use them

---

<CommerceModuleSections name="Payment" />
<CommerceModuleSections />
15 changes: 15 additions & 0 deletions www/apps/resources/app/commerce-modules/payment/workflows/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `Payment Workflows`,
}

# {metadata.title}

[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.

When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage payments and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.

The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).

<ChildDocs type="item" defaultItemsPerRow={2} />
15 changes: 15 additions & 0 deletions www/apps/resources/app/commerce-modules/pricing/js-sdk/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"

export const metadata = {
title: `Pricing JS SDK Methods`,
}

# {metadata.title}

The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.

Use the following methods or properties to send requests to pricing related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.

The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).

<ChildDocs type="item" />
2 changes: 1 addition & 1 deletion www/apps/resources/app/commerce-modules/pricing/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -169,4 +169,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor

---

<CommerceModuleSections name="Pricing" />
<CommerceModuleSections />
Loading

0 comments on commit 44706ef

Please sign in to comment.