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

docs: edits and fixes to commerce module docs (#7468)

Browse Source 
Apply edits and fixes to the commerce modules docs
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-05-29 11:08:06 +00:00
1 parent 130de74d6d
commit 2c5ba408d4
160 files changed
+6400 -3790
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/generated/files-map.mjs
+44 -20
View File
@@ -279,10 +279,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/auth/page.mdx",
"pathname": "/commerce-modules/auth"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/auth/persisting-auth-user/page.mdx",
"pathname": "/commerce-modules/auth/persisting-auth-user"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/auth/user-creation/page.mdx",
"pathname": "/commerce-modules/auth/user-creation"
@@ -392,8 +388,8 @@ export const filesMap = [
"pathname": "/commerce-modules/fulfillment/relations-to-other-modules"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/shipping-options/page.mdx",
"pathname": "/commerce-modules/fulfillment/shipping-options"
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/shipping-option/page.mdx",
"pathname": "/commerce-modules/fulfillment/shipping-option"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/inventory/concepts/page.mdx",
@@ -439,10 +435,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/order/order-change/page.mdx",
"pathname": "/commerce-modules/order/order-change"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/order/order-items/page.mdx",
"pathname": "/commerce-modules/order/order-items"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/order/order-versioning/page.mdx",
"pathname": "/commerce-modules/order/order-versioning"
@@ -547,6 +539,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/pricing/price-calculation/page.mdx",
"pathname": "/commerce-modules/pricing/price-calculation"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/pricing/price-rules/page.mdx",
"pathname": "/commerce-modules/pricing/price-rules"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/pricing/relations-to-other-modules/page.mdx",
"pathname": "/commerce-modules/pricing/relations-to-other-modules"
@@ -575,6 +571,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/promotion/actions/page.mdx",
"pathname": "/commerce-modules/promotion/actions"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/promotion/application-method/page.mdx",
"pathname": "/commerce-modules/promotion/application-method"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/promotion/campaign/page.mdx",
"pathname": "/commerce-modules/promotion/campaign"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/promotion/concepts/page.mdx",
"pathname": "/commerce-modules/promotion/concepts"
@@ -1176,8 +1180,8 @@ export const filesMap = [
"pathname": "/references/auth/IMessageAggregator/methods/auth.IMessageAggregator.saveRawMessageData"
},
{
"filePath": "/www/apps/resources/references/auth/interfaces/auth.AuthUserDTO/page.mdx",
"pathname": "/references/auth/interfaces/auth.AuthUserDTO"
"filePath": "/www/apps/resources/references/auth/interfaces/auth.AuthIdentityDTO/page.mdx",
"pathname": "/references/auth/interfaces/auth.AuthIdentityDTO"
},
{
"filePath": "/www/apps/resources/references/auth/interfaces/auth.AuthenticationInput/page.mdx",
@@ -1196,12 +1200,12 @@ export const filesMap = [
"pathname": "/references/auth/interfaces/auth.Context"
},
{
"filePath": "/www/apps/resources/references/auth/interfaces/auth.CreateAuthUserDTO/page.mdx",
"pathname": "/references/auth/interfaces/auth.CreateAuthUserDTO"
"filePath": "/www/apps/resources/references/auth/interfaces/auth.CreateAuthIdentityDTO/page.mdx",
"pathname": "/references/auth/interfaces/auth.CreateAuthIdentityDTO"
},
{
"filePath": "/www/apps/resources/references/auth/interfaces/auth.FilterableAuthUserProps/page.mdx",
"pathname": "/references/auth/interfaces/auth.FilterableAuthUserProps"
"filePath": "/www/apps/resources/references/auth/interfaces/auth.FilterableAuthIdentityProps/page.mdx",
"pathname": "/references/auth/interfaces/auth.FilterableAuthIdentityProps"
},
{
"filePath": "/www/apps/resources/references/auth/interfaces/auth.FindConfig/page.mdx",
@@ -1232,8 +1236,8 @@ export const filesMap = [
"pathname": "/references/auth/interfaces/auth.MessageAggregatorFormat"
},
{
"filePath": "/www/apps/resources/references/auth/interfaces/auth.UpdateAuthUserDTO/page.mdx",
"pathname": "/references/auth/interfaces/auth.UpdateAuthUserDTO"
"filePath": "/www/apps/resources/references/auth/interfaces/auth.UpdateAuthIdentityDTO/page.mdx",
"pathname": "/references/auth/interfaces/auth.UpdateAuthIdentityDTO"
},
{
"filePath": "/www/apps/resources/references/auth/types/auth.JoinerRelationship/page.mdx",
@@ -1260,8 +1264,12 @@ export const filesMap = [
"pathname": "/references/auth/types/auth.ModuleJoinerRelationship"
},
{
"filePath": "/www/apps/resources/references/auth_models/classes/auth_models.AuthUser/page.mdx",
"pathname": "/references/auth_models/classes/auth_models.AuthUser"
"filePath": "/www/apps/resources/references/auth_models/classes/auth_models.AuthIdentity/page.mdx",
"pathname": "/references/auth_models/classes/auth_models.AuthIdentity"
},
{
"filePath": "/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx",
"pathname": "/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider"
},
{
"filePath": "/www/apps/resources/references/cart/ICartModuleService/methods/cart.ICartModuleService.addLineItemAdjustments/page.mdx",
@@ -2851,6 +2859,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/fulfillment_models/classes/fulfillment_models.ShippingProfile/page.mdx",
"pathname": "/references/fulfillment_models/classes/fulfillment_models.ShippingProfile"
},
{
"filePath": "/www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx",
"pathname": "/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService"
},
{
"filePath": "/www/apps/resources/references/inventory_next/IInventoryServiceNext/methods/inventory_next.IInventoryServiceNext.adjustInventory/page.mdx",
"pathname": "/references/inventory_next/IInventoryServiceNext/methods/inventory_next.IInventoryServiceNext.adjustInventory"
@@ -5807,6 +5819,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/medusa/types/medusa.payload/page.mdx",
"pathname": "/references/medusa/types/medusa.payload"
},
{
"filePath": "/www/apps/resources/references/medusa_config/interfaces/medusa_config.AdminOptions/page.mdx",
"pathname": "/references/medusa_config/interfaces/medusa_config.AdminOptions"
},
{
"filePath": "/www/apps/resources/references/medusa_config/interfaces/medusa_config.ConfigModule/page.mdx",
"pathname": "/references/medusa_config/interfaces/medusa_config.ConfigModule"
@@ -6251,6 +6267,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/modules/auth_models/page.mdx",
"pathname": "/references/modules/auth_models"
},
{
"filePath": "/www/apps/resources/references/modules/auth_provider/page.mdx",
"pathname": "/references/modules/auth_provider"
},
{
"filePath": "/www/apps/resources/references/modules/cart/page.mdx",
"pathname": "/references/modules/cart"
@@ -6287,6 +6307,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/modules/fulfillment_models/page.mdx",
"pathname": "/references/modules/fulfillment_models"
},
{
"filePath": "/www/apps/resources/references/modules/fulfillment_provider/page.mdx",
"pathname": "/references/modules/fulfillment_provider"
},
{
"filePath": "/www/apps/resources/references/modules/inventory_next/page.mdx",
"pathname": "/references/modules/inventory_next"
www/apps/resources/generated/sidebar.mjs
+91 -70
View File
@@ -59,9 +59,9 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/references/api-key",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "IApiKeyModuleService Reference",
"childSidebarTitle": "API Key Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -181,13 +181,6 @@ export const generatedSidebar = [
"title": "Auth Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/auth/module-options",
"title": "Module Options",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -220,13 +213,6 @@ export const generatedSidebar = [
"path": "/commerce-modules/auth/user-creation",
"title": "User Creation",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/auth/persisting-auth-user",
"title": "Persisting Auth User",
"children": []
}
]
},
@@ -235,13 +221,20 @@ export const generatedSidebar = [
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/auth/provider",
"title": "Create Auth Provider Module",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/auth",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "IAuthModuleService Reference",
"childSidebarTitle": "Auth Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -328,8 +321,8 @@ export const generatedSidebar = [
{
"loaded": true,
"isPathHref": true,
"path": "/references/auth/models/AuthUser",
"title": "AuthUser",
"path": "/references/auth/models/AuthIdentity",
"title": "AuthIdentity",
"children": []
}
]
@@ -405,9 +398,9 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/references/cart",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "ICartModuleService Reference",
"childSidebarTitle": "Cart Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -879,9 +872,9 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/references/currency",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "ICurrencyModuleService Reference",
"childSidebarTitle": "Cart Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -996,9 +989,9 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/references/customer",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "ICustomerModuleService Reference",
"childSidebarTitle": "Customer Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -1273,8 +1266,8 @@ export const generatedSidebar = [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/fulfillment/shipping-options",
"title": "Shipping Options",
"path": "/commerce-modules/fulfillment/shipping-option",
"title": "Shipping Option",
"children": []
},
{
@@ -1287,7 +1280,7 @@ export const generatedSidebar = [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/fulfillment/relation-to-other-modules",
"path": "/commerce-modules/fulfillment/relations-to-other-modules",
"title": "Relations to Other Modules",
"children": []
}
@@ -1298,13 +1291,20 @@ export const generatedSidebar = [
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/provider",
"title": "Create Fulfillment Provider Module",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "IFulfillmentModuleService Reference",
"childSidebarTitle": "Fulfillment Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -1923,9 +1923,9 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/references/inventory_next",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "IInventoryServiceNext Reference",
"childSidebarTitle": "Inventory Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -2246,13 +2246,6 @@ export const generatedSidebar = [
"title": "Order Concepts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/order/order-items",
"title": "Order Title",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -2306,9 +2299,9 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/references/order",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "IOrderModuleService Reference",
"childSidebarTitle": "Order Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -2903,13 +2896,6 @@ export const generatedSidebar = [
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/payment/payment-flow",
"title": "Payment Flow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -2926,6 +2912,20 @@ export const generatedSidebar = [
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "Guides",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/payment/payment-flow",
"title": "Accept Payment Flow",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
@@ -2942,9 +2942,9 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/references/payment",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "IPaymentModuleService Reference",
"childSidebarTitle": "Payment Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -3223,6 +3223,13 @@ export const generatedSidebar = [
"title": "Pricing Concepts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/pricing/price-rules",
"title": "Price Rules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -3248,9 +3255,9 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/references/pricing",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "IPricingModuleService Reference",
"childSidebarTitle": "Pricing Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -3708,9 +3715,9 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/references/product",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "IProductModuleService Reference",
"childSidebarTitle": "Product Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -4231,7 +4238,21 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/promotion/concepts",
"title": "Promotion Concepts",
"title": "Promotion",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/promotion/application-method",
"title": "Application Method",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/promotion/campaign",
"title": "Campaign",
"children": []
},
{
@@ -4259,9 +4280,9 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/references/promotion",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "IPromotionModuleService Reference",
"childSidebarTitle": "Promotion Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -4565,9 +4586,9 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/references/region",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "IRegionModuleService Reference",
"childSidebarTitle": "Region Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -4752,9 +4773,9 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/references/sales-channel",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "ISalesChannelModuleService Reference",
"childSidebarTitle": "Sales Channel Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -4911,9 +4932,9 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/references/stock-location",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "IStockLocationServiceNext Reference",
"childSidebarTitle": "Stock Location Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -5056,9 +5077,9 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/references/store",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "IStoreModuleService Reference",
"childSidebarTitle": "Store Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -5236,9 +5257,9 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/references/tax",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "ITaxModuleService Reference",
"childSidebarTitle": "Tax Module's Main Service Reference",
"children": [
{
"loaded": true,
@@ -5493,9 +5514,9 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"path": "/references/user",
"title": "Interface Reference",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "IUserModuleService Reference",
"childSidebarTitle": "User Module's Main Service Reference",
"children": [
{
"loaded": true,
www/apps/resources/generated/slug-changes.mjs
+13 -3
View File
@@ -100,9 +100,14 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/auth/interfaces/auth.IAuthModuleService/page.mdx"
},
{
"origSlug": "/references/auth_models/classes/auth_models.AuthUser",
"newSlug": "/references/auth/models/AuthUser",
"filePath": "/www/apps/resources/references/auth_models/classes/auth_models.AuthUser/page.mdx"
"origSlug": "/references/auth_models/classes/auth_models.AuthIdentity",
"newSlug": "/references/auth/models/AuthIdentity",
"filePath": "/www/apps/resources/references/auth_models/classes/auth_models.AuthIdentity/page.mdx"
},
{
"origSlug": "/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider",
"newSlug": "/references/auth/provider",
"filePath": "/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx"
},
{
"origSlug": "/references/cart/ICartModuleService/methods/cart.ICartModuleService.addLineItemAdjustments",
@@ -954,6 +959,11 @@ export const slugChanges = [
"newSlug": "/references/fulfillment/models/ShippingProfile",
"filePath": "/www/apps/resources/references/fulfillment_models/classes/fulfillment_models.ShippingProfile/page.mdx"
},
{
"origSlug": "/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService",
"newSlug": "/references/fulfillment/provider",
"filePath": "/www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx"
},
{
"origSlug": "/references/inventory_next/IInventoryServiceNext/methods/inventory_next.IInventoryServiceNext.adjustInventory",
"newSlug": "/references/inventory-next/adjustInventory",