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

docs: added how-to guides for architectural modules (#11883)

Browse Source 
* added initial how-tos

* finished changes

* generated sidebars
This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-03-18 09:49:19 +02:00
1 parent 0099c1e2e9
commit cb68a9e67b
37 files changed
+5265 -68
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/packages/tags/src/tags/cache.ts
+4
View File
@@ -2,5 +2,9 @@ export const cache = [
{
"title": "Create Cache Module",
"path": "https://docs.medusajs.com/resources/architectural-modules/cache/create"
},
{
"title": "Use Cache Module",
"path": "https://docs.medusajs.com/resources/references/cache-service"
}
]
www/packages/tags/src/tags/event.ts
+4
View File
@@ -2,5 +2,9 @@ export const event = [
{
"title": "Create Event Module",
"path": "https://docs.medusajs.com/resources/architectural-modules/event/create"
},
{
"title": "Use Event Module",
"path": "https://docs.medusajs.com/resources/references/event-service"
}
]
www/packages/tags/src/tags/file.ts
+4
View File
@@ -23,6 +23,10 @@ export const file = [
"title": "exportProductsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/exportProductsWorkflow"
},
{
"title": "Use File Module",
"path": "https://docs.medusajs.com/resources/references/file-service"
},
{
"title": "upload",
"path": "https://docs.medusajs.com/resources/references/js-sdk/admin/upload"
www/packages/tags/src/tags/how-to.ts
+20
View File
@@ -11,6 +11,10 @@ export const howTo = [
"title": "Send Notification",
"path": "https://docs.medusajs.com/resources/architectural-modules/notification/send-notification"
},
{
"title": "Use Workflow Engine Module",
"path": "https://docs.medusajs.com/resources/architectural-modules/workflow-engine/how-to-use"
},
{
"title": "Create Actor Type",
"path": "https://docs.medusajs.com/resources/commerce-modules/auth/create-actor-type"
@@ -31,6 +35,18 @@ export const howTo = [
"title": "Create Auth Provider",
"path": "https://docs.medusajs.com/resources/references/auth/provider"
},
{
"title": "Use Cache Module",
"path": "https://docs.medusajs.com/resources/references/cache-service"
},
{
"title": "Use Event Module",
"path": "https://docs.medusajs.com/resources/references/event-service"
},
{
"title": "Use File Module",
"path": "https://docs.medusajs.com/resources/references/file-service"
},
{
"title": "Create Fulfillment Provider",
"path": "https://docs.medusajs.com/resources/references/fulfillment/provider"
@@ -47,6 +63,10 @@ export const howTo = [
"title": "Create Notification Provider",
"path": "https://docs.medusajs.com/resources/references/notification-provider-module"
},
{
"title": "Use Notification Module",
"path": "https://docs.medusajs.com/resources/references/notification-service"
},
{
"title": "Create Payment Provider",
"path": "https://docs.medusajs.com/resources/references/payment/provider"
www/packages/tags/src/tags/index.ts
+40 -39
View File
@@ -1,45 +1,46 @@
export * from "./user-guide.js"
export * from "./admin.js"
export * from "./api-key.js"
export * from "./auth.js"
export * from "./cache.js"
export * from "./cart.js"
export * from "./checkout.js"
export * from "./concept.js"
export * from "./currency.js"
export * from "./customer.js"
export * from "./event-bus.js"
export * from "./event.js"
export * from "./example.js"
export * from "./extend-module.js"
export * from "./file.js"
export * from "./fulfillment.js"
export * from "./how-to.js"
export * from "./inventory.js"
export * from "./js-sdk.js"
export * from "./link.js"
export * from "./locking.js"
export * from "./logger.js"
export * from "./notification.js"
export * from "./order.js"
export * from "./payment.js"
export * from "./cache.js"
export * from "./how-to.js"
export * from "./server.js"
export * from "./product.js"
export * from "./pricing.js"
export * from "./event.js"
export * from "./promotion.js"
export * from "./notification.js"
export * from "./auth.js"
export * from "./api-key.js"
export * from "./workflow.js"
export * from "./stock-location.js"
export * from "./inventory.js"
export * from "./sales-channel.js"
export * from "./user.js"
export * from "./region.js"
export * from "./store.js"
export * from "./cart.js"
export * from "./currency.js"
export * from "./extend-module.js"
export * from "./tutorial.js"
export * from "./fulfillment.js"
export * from "./tax.js"
export * from "./concept.js"
export * from "./stripe.js"
export * from "./storefront.js"
export * from "./product-category.js"
export * from "./query.js"
export * from "./checkout.js"
export * from "./publishable-api-key.js"
export * from "./product-collection.js"
export * from "./step.js"
export * from "./example.js"
export * from "./customer.js"
export * from "./locking.js"
export * from "./product.js"
export * from "./promotion.js"
export * from "./publishable-api-key.js"
export * from "./query.js"
export * from "./region.js"
export * from "./remote-query.js"
export * from "./link.js"
export * from "./event-bus.js"
export * from "./logger.js"
export * from "./file.js"
export * from "./js-sdk.js"
export * from "./admin.js"
export * from "./sales-channel.js"
export * from "./server.js"
export * from "./step.js"
export * from "./stock-location.js"
export * from "./store.js"
export * from "./storefront.js"
export * from "./stripe.js"
export * from "./tax.js"
export * from "./tutorial.js"
export * from "./user-guide.js"
export * from "./user.js"
export * from "./workflow-engine.js"
export * from "./workflow.js"
www/packages/tags/src/tags/notification.ts
+4
View File
@@ -30,5 +30,9 @@ export const notification = [
{
"title": "Create Notification Provider",
"path": "https://docs.medusajs.com/resources/references/notification-provider-module"
},
{
"title": "Use Notification Module",
"path": "https://docs.medusajs.com/resources/references/notification-service"
}
]
www/packages/tags/src/tags/server.ts
+20
View File
@@ -11,6 +11,10 @@ export const server = [
"title": "Send Notification",
"path": "https://docs.medusajs.com/resources/architectural-modules/notification/send-notification"
},
{
"title": "Use Workflow Engine Module",
"path": "https://docs.medusajs.com/resources/architectural-modules/workflow-engine/how-to-use"
},
{
"title": "Create Actor Type",
"path": "https://docs.medusajs.com/resources/commerce-modules/auth/create-actor-type"
@@ -59,6 +63,18 @@ export const server = [
"title": "Create Auth Provider",
"path": "https://docs.medusajs.com/resources/references/auth/provider"
},
{
"title": "Use Cache Module",
"path": "https://docs.medusajs.com/resources/references/cache-service"
},
{
"title": "Use Event Module",
"path": "https://docs.medusajs.com/resources/references/event-service"
},
{
"title": "Use File Module",
"path": "https://docs.medusajs.com/resources/references/file-service"
},
{
"title": "Create Fulfillment Provider",
"path": "https://docs.medusajs.com/resources/references/fulfillment/provider"
@@ -75,6 +91,10 @@ export const server = [
"title": "Create Notification Provider",
"path": "https://docs.medusajs.com/resources/references/notification-provider-module"
},
{
"title": "Use Notification Module",
"path": "https://docs.medusajs.com/resources/references/notification-service"
},
{
"title": "Create Payment Provider",
"path": "https://docs.medusajs.com/resources/references/payment/provider"
www/packages/tags/src/tags/workflow-engine.ts
+6
View File
@@ -0,0 +1,6 @@
export const workflowEngine = [
{
"title": "Use Workflow Engine Module",
"path": "https://docs.medusajs.com/resources/architectural-modules/workflow-engine/how-to-use"
}
]
www/packages/tags/src/utils/generate-tags.ts
+1 -1
View File
@@ -158,6 +158,6 @@ export async function generateTags(basePath?: string) {
)
// write index.ts
const indexContent = files.map((file) => `export * from "./${file}"\n`)
const indexContent = files.sort().map((file) => `export * from "./${file}"\n`)
await writeFile(path.join(tagsDir, "index.ts"), indexContent)
}