Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: updates and fixes in utils + fulfillment provider changes #9347

Merged
merged 5 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion www/apps/book/app/more-resources/examples/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ This chapter provides links to example sections on different Medusa topics.
### Auth

- [Create a custom actor type](!resources!/commerce-modules/auth/create-actor-type)
- [Create auth provider module](!resources!/references/auth/provider)

### Cart

Expand All @@ -101,19 +102,43 @@ This chapter provides links to example sections on different Medusa topics.

### Fulfillment

- [Create a fulfillment module provider](!resources!/recipes/digital-products/examples/standard#step-10-create-digital-product-fulfillment-module-provider)
- [Create fulfillment module provider](!resources!/recipes/digital-products/examples/standard#step-10-create-digital-product-fulfillment-module-provider)

### Order

- [Retrieve promotion actions of an order](!resources!/commerce-modules/order/promotion-adjustments#promotion-actions)

### Payment

- [Create payment module provider](!resources!/references/payment/provider)

### Product

- [Retrieve prices of product variants](!resources!/commerce-modules/product/guides/price)
- [Retrieve product variant prices with taxes](!resources!/commerce-modules/product/guides/price-with-taxes)

---

## Architectural Modules

### Cache

- [Create cache module](!resources!/architectural-modules/cache/create)

### Event

- [Create event module](!resources!/architectural-modules/event/create)

### File

- [Create file module provider](!resources!/references/file-provider-module)

### Notification

- [Create notification module provider](!resources!/references/notification-provider-module)

---

## Integrations

- [Send a notification with SendGrid](!resources!/architectural-modules/notification/sendgrid#test-out-the-module)
2 changes: 1 addition & 1 deletion www/apps/book/generated/edit-dates.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ export const generatedEditDates = {
"app/customization/next-steps/page.mdx": "2024-09-12T10:50:04.873Z",
"app/customization/page.mdx": "2024-09-12T11:16:18.504Z",
"app/more-resources/cheatsheet/page.mdx": "2024-07-11T16:11:26.480Z",
"app/more-resources/examples/page.mdx": "2024-09-19T10:30:30.398Z",
"app/more-resources/examples/page.mdx": "2024-09-27T07:17:16.892Z",
"app/architecture/architectural-modules/page.mdx": "2024-09-23T12:51:04.520Z",
"app/architecture/overview/page.mdx": "2024-09-23T12:55:01.339Z",
"app/advanced-development/data-models/infer-type/page.mdx": "2024-09-26T08:28:13.041Z"
Expand Down
56 changes: 36 additions & 20 deletions www/apps/resources/generated/sidebar.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,14 @@ export const generatedSidebar = [
"path": "/commerce-modules/auth/create-actor-type",
"title": "Create an Actor Type",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/auth/provider",
"title": "Create Auth Provider Module",
"children": []
}
]
},
Expand Down Expand Up @@ -319,14 +327,6 @@ export const generatedSidebar = [
"type": "sub-category",
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/auth/provider",
"title": "Create Auth Provider Module",
"children": []
},
{
"loaded": true,
"isPathHref": true,
Expand Down Expand Up @@ -1601,7 +1601,7 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"type": "sub-category",
"title": "References",
"title": "Guides",
"children": [
{
"loaded": true,
Expand All @@ -1610,7 +1610,15 @@ export const generatedSidebar = [
"path": "/references/fulfillment/provider",
"title": "Create Fulfillment Provider Module",
"children": []
},
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "sub-category",
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
Expand Down Expand Up @@ -4144,6 +4152,14 @@ export const generatedSidebar = [
"path": "/commerce-modules/payment/payment-flow",
"title": "Accept Payment Flow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/payment/provider",
"title": "Create Payment Provider",
"children": []
}
]
},
Expand All @@ -4153,14 +4169,6 @@ export const generatedSidebar = [
"type": "sub-category",
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/payment/provider",
"title": "Payment Provider Reference",
"children": []
},
{
"loaded": true,
"isPathHref": true,
Expand Down Expand Up @@ -7004,7 +7012,7 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"type": "sub-category",
"title": "References",
"title": "Guides",
"children": [
{
"loaded": true,
Expand All @@ -7013,7 +7021,15 @@ export const generatedSidebar = [
"path": "/references/tax/provider",
"title": "Tax Provider Reference",
"children": []
},
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "sub-category",
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
Expand Down
36 changes: 24 additions & 12 deletions www/apps/resources/sidebar.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,11 @@ export const sidebar = sidebarAttachHrefCommonOptions([
path: "/commerce-modules/auth/create-actor-type",
title: "Create an Actor Type",
},
{
type: "link",
path: "/references/auth/provider",
title: "Create Auth Provider Module",
},
],
},
{
Expand Down Expand Up @@ -165,11 +170,6 @@ export const sidebar = sidebarAttachHrefCommonOptions([
type: "sub-category",
title: "References",
children: [
{
type: "link",
path: "/references/auth/provider",
title: "Create Auth Provider Module",
},
{
type: "link",
path: "/references/auth",
Expand Down Expand Up @@ -460,13 +460,19 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
{
type: "sub-category",
title: "References",
title: "Guides",
children: [
{
type: "link",
path: "/references/fulfillment/provider",
title: "Create Fulfillment Provider Module",
},
],
},
{
type: "sub-category",
title: "References",
children: [
{
type: "link",
path: "/references/fulfillment",
Expand Down Expand Up @@ -747,17 +753,17 @@ export const sidebar = sidebarAttachHrefCommonOptions([
path: "/commerce-modules/payment/payment-flow",
title: "Accept Payment Flow",
},
{
type: "link",
path: "/references/payment/provider",
title: "Create Payment Provider",
},
],
},
{
type: "sub-category",
title: "References",
children: [
{
type: "link",
path: "/references/payment/provider",
title: "Payment Provider Reference",
},
{
type: "link",
path: "/references/payment",
Expand Down Expand Up @@ -1339,13 +1345,19 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
{
type: "sub-category",
title: "References",
title: "Guides",
children: [
{
type: "link",
path: "/references/tax/provider",
title: "Tax Provider Reference",
},
],
},
{
type: "sub-category",
title: "References",
children: [
{
type: "link",
path: "/references/tax",
Expand Down
4 changes: 2 additions & 2 deletions www/utils/packages/react-docs-generator/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"react-docgen": "^7.0.1",
"resolve": "^1.22.8",
"ts-node": "^10.9.1",
"typedoc": "^0.26.2",
"typedoc": "^0.26.7",
"typedoc-plugin-custom": "*",
"typescript": "^5.6.2",
"utils": "*"
Expand All @@ -31,6 +31,6 @@
"@types/node": "^20.12.10"
},
"peerDependencies": {
"typedoc": "0.25.x"
"typedoc": "0.26.x"
}
}
5 changes: 5 additions & 0 deletions www/utils/packages/typedoc-config/api-key.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,10 @@
"$schema": "http://json.schemastore.org/tsconfig",
"extends": [
"../../../../packages/modules/api-key/tsconfig.json"
],
"include": ["../../../../packages/modules/api-key/src"],
"exclude": [
"../../../../packages/modules/api-key/dist",
"../../../../packages/modules/api-key/node_modules"
]
}
5 changes: 5 additions & 0 deletions www/utils/packages/typedoc-config/auth.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,10 @@
"$schema": "http://json.schemastore.org/tsconfig",
"extends": [
"../../../../packages/modules/auth/tsconfig.json"
],
"include": ["../../../../packages/modules/auth/src"],
"exclude": [
"../../../../packages/modules/auth/dist",
"../../../../packages/modules/auth/node_modules"
]
}
5 changes: 5 additions & 0 deletions www/utils/packages/typedoc-config/cart.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,10 @@
"$schema": "http://json.schemastore.org/tsconfig",
"extends": [
"../../../../packages/modules/cart/tsconfig.json"
],
"include": ["../../../../packages/modules/cart/src"],
"exclude": [
"../../../../packages/modules/cart/dist",
"../../../../packages/modules/cart/node_modules"
]
}
5 changes: 5 additions & 0 deletions www/utils/packages/typedoc-config/core-flows.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,10 @@
"$schema": "http://json.schemastore.org/tsconfig",
"extends": [
"../../../../packages/core/core-flows/tsconfig.json"
],
"include": ["../../../../packages/core/core-flows/src"],
"exclude": [
"../../../../packages/core/core-flows/dist",
"../../../../packages/core/core-flows/node_modules"
]
}
5 changes: 5 additions & 0 deletions www/utils/packages/typedoc-config/currency.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,10 @@
"$schema": "http://json.schemastore.org/tsconfig",
"extends": [
"../../../../packages/modules/currency/tsconfig.json"
],
"include": ["../../../../packages/modules/currency/src"],
"exclude": [
"../../../../packages/modules/currency/dist",
"../../../../packages/modules/currency/node_modules"
]
}
5 changes: 5 additions & 0 deletions www/utils/packages/typedoc-config/customer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,10 @@
"$schema": "http://json.schemastore.org/tsconfig",
"extends": [
"../../../../packages/modules/customer/tsconfig.json"
],
"include": ["../../../../packages/modules/customer/src"],
"exclude": [
"../../../../packages/modules/customer/dist",
"../../../../packages/modules/customer/node_modules"
]
}
5 changes: 5 additions & 0 deletions www/utils/packages/typedoc-config/framework.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,10 @@
"$schema": "http://json.schemastore.org/tsconfig",
"extends": [
"../../../../packages/framework/framework/tsconfig.json"
],
"include": ["../../../../packages/framework/framework/src"],
"exclude": [
"../../../../packages/framework/framework/dist",
"../../../../packages/framework/framework/node_modules"
]
}
5 changes: 5 additions & 0 deletions www/utils/packages/typedoc-config/fulfillment.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,10 @@
"$schema": "http://json.schemastore.org/tsconfig",
"extends": [
"../../../../packages/modules/fulfillment/tsconfig.json"
],
"include": ["../../../../packages/modules/fulfillment/src"],
"exclude": [
"../../../../packages/modules/fulfillment/dist",
"../../../../packages/modules/fulfillment/node_modules"
]
}
5 changes: 5 additions & 0 deletions www/utils/packages/typedoc-config/inventory-next.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,10 @@
"$schema": "http://json.schemastore.org/tsconfig",
"extends": [
"../../../../packages/modules/inventory-next/tsconfig.json"
],
"include": ["../../../../packages/modules/inventory-next/src"],
"exclude": [
"../../../../packages/modules/inventory-next/dist",
"../../../../packages/modules/inventory-next/node_modules"
]
}
6 changes: 0 additions & 6 deletions www/utils/packages/typedoc-config/js-client.json

This file was deleted.

Loading
Loading