docs: general fixes and additions (#10876)

This commit is contained in:
Shahed Nasser
2025-01-08 16:09:48 +02:00
committed by GitHub
parent 9427f1e4af
commit a0e944a7a8
12 changed files with 235 additions and 74 deletions
+21 -2
View File
@@ -1,4 +1,4 @@
import { ChildDocs } from "docs-ui"
import { CardList } from "docs-ui"
export const metadata = {
title: `Cache Modules`,
@@ -18,7 +18,26 @@ By default, Medusa uses the In-Memory Cache Module. This module uses a plain Jav
This is useful for development. However, for production, it's highly recommended to use other Cache Modules, such as the Redis Cache Module.
<ChildDocs type="item" hideItems={["Guides"]} onlyTopLevel={true} />
<CardList
items={[
{
title: "In-Memory",
href: "/architectural-modules/cache/in-memory",
badge: {
variant: "neutral",
children: "For Development"
}
},
{
title: "Redis",
href: "/architectural-modules/cache/redis",
badge: {
variant: "green",
children: "For Production"
}
}
]}
/>
---
@@ -1,4 +1,4 @@
import { ChildDocs } from "docs-ui"
import { CardList } from "docs-ui"
export const metadata = {
title: `Event Modules`,
@@ -18,7 +18,26 @@ By default, Medusa uses the Local Event Module. This module uses Nodes EventE
This is useful for development. However, for production, its highly recommended to use other Event Modules, Redis Event Module.
<ChildDocs type="item" hideItems={["Guides"]} onlyTopLevel={true} />
<CardList
items={[
{
title: "Local",
href: "/architectural-modules/event/local",
badge: {
variant: "neutral",
children: "For Development"
}
},
{
title: "Redis",
href: "/architectural-modules/event/redis",
badge: {
variant: "green",
children: "For Production"
}
}
]}
/>
---
@@ -1,4 +1,4 @@
import { ChildDocs } from "docs-ui"
import { CardList } from "docs-ui"
export const metadata = {
title: `File Module Providers`,
@@ -14,7 +14,26 @@ By default, Medusa uses the Local File Module. This module uploads files to the
This is useful for development. However, for production, its highly recommended to use other File Modules, such as the S3 Module.
<ChildDocs type="item" hideItems={["Guides"]} onlyTopLevel={true} />
<CardList
items={[
{
title: "Local",
href: "/architectural-modules/file/local",
badge: {
variant: "neutral",
children: "For Development"
}
},
{
title: "AWS S3 (and Compatible APIs)",
href: "/architectural-modules/file/s3",
badge: {
variant: "green",
children: "For Production"
}
}
]}
/>
---
@@ -1,4 +1,4 @@
import { ChildDocs } from "docs-ui"
import { CardList } from "docs-ui"
export const metadata = {
title: `Notification Module Providers`,
@@ -18,7 +18,26 @@ By default, Medusa uses the Local Notification Module which only simulates sendi
Medusa provides other Notification Modules that actually send notifications, such as the SendGrid Notification Module Provider.
<ChildDocs type="item" hideItems={["Guides"]} onlyTopLevel={true} />
<CardList
items={[
{
title: "Local",
href: "/architectural-modules/notification/local",
badge: {
variant: "neutral",
children: "For Development"
}
},
{
title: "SendGrid",
href: "/architectural-modules/notification/sendgrid",
badge: {
variant: "green",
children: "For Production"
}
}
]}
/>
---
@@ -1,4 +1,4 @@
import { ChildDocs, CardList } from "docs-ui"
import { CardList } from "docs-ui"
export const metadata = {
title: `Architectural Modules`,
@@ -1,4 +1,4 @@
import { ChildDocs } from "docs-ui"
import { CardList } from "docs-ui"
export const metadata = {
title: `Workflow Engine Modules`,
@@ -10,4 +10,23 @@ Workflow engine modules handle tracking and recording the transactions and statu
Medusa uses the In-Memory Workflow Engine Module by default. For production purposes, it's recommended to use the Redis Engine Module instead.
<ChildDocs type="item" hideItems={["Guides"]} onlyTopLevel={true} />
<CardList
items={[
{
title: "In-Memory",
href: "/architectural-modules/workflow-engine/in-memory",
badge: {
variant: "neutral",
children: "For Development"
}
},
{
title: "Redis",
href: "/architectural-modules/workflow-engine/redis",
badge: {
variant: "green",
children: "For Production"
}
}
]}
/>