docs: general fixes and additions (#10876)

medusajs · Jan 8, 2025 · a0e944a · a0e944a
1 parent 9427f1e
commit a0e944a
Show file tree

Hide file tree

Showing 12 changed files with 235 additions and 74 deletions.
diff --git a/www/apps/book/app/learn/page.mdx b/www/apps/book/app/learn/page.mdx
@@ -17,7 +17,7 @@ Medusa ships with three main tools:
 
 When you install Medusa, you get a fully fledged commerce platform with all the features you need to get off the ground. However, unlike other platforms, Medusa is built with customization in mind. You don't need to build hacky workarounds that are difficult to maintain and scale. Your efforts go into building features that brings your business's vision to life.
 
---- 
+---
 
 ## Who should use Medusa
 
@@ -84,6 +84,10 @@ This documentation is split into the following sections:
 
 To get started, check out the [Installation chapter](./installation/page.mdx).
 
+### Using with LLM Editors
+
+This documentation provides an [llms.txt](https://docs.medusajs.com/llms.txt) file to support LLM editors such as Cursor. Add the documentation to the list of supported documentation in your LLM editor to access the documentation directly from your editor and benefit from code generation.
+
 ---
 
 ## Useful Links

diff --git a/www/apps/book/generated/edit-dates.mjs b/www/apps/book/generated/edit-dates.mjs
@@ -2,7 +2,7 @@ export const generatedEditDates = {
   "app/learn/fundamentals/scheduled-jobs/page.mdx": "2024-12-09T10:51:40.570Z",
   "app/learn/fundamentals/workflows/page.mdx": "2024-12-09T14:45:17.837Z",
   "app/learn/deployment/page.mdx": "2024-11-25T14:32:44.949Z",
-  "app/learn/page.mdx": "2024-11-28T14:17:53.023Z",
+  "app/learn/page.mdx": "2025-01-08T10:49:58.879Z",
   "app/learn/fundamentals/modules/commerce-modules/page.mdx": "2024-12-09T10:46:29.339Z",
   "app/learn/fundamentals/workflows/retry-failed-steps/page.mdx": "2024-12-04T07:37:59.823Z",
   "app/learn/fundamentals/workflows/workflow-hooks/page.mdx": "2024-12-09T10:44:33.781Z",

diff --git a/www/apps/book/sidebar.mjs b/www/apps/book/sidebar.mjs
@@ -198,8 +198,8 @@ export const sidebar = numberSidebarItems(
             },
             {
               type: "link",
-              path: "/learn/fundamentals/module-links/remote-link",
-              title: "Remote Link",
+              path: "/learn/fundamentals/module-links/link",
+              title: "Link",
             },
             {
               type: "link",

diff --git a/www/apps/resources/app/architectural-modules/cache/page.mdx b/www/apps/resources/app/architectural-modules/cache/page.mdx
@@ -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"
+      }
+    }
+  ]}
+/>
 
 ---
 

diff --git a/www/apps/resources/app/architectural-modules/event/page.mdx b/www/apps/resources/app/architectural-modules/event/page.mdx
@@ -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 Node’s EventE
 
 This is useful for development. However, for production, it’s 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"
+      }
+    }
+  ]}
+/>
 
 ---
 

diff --git a/www/apps/resources/app/architectural-modules/file/page.mdx b/www/apps/resources/app/architectural-modules/file/page.mdx
@@ -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, it’s 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"
+      }
+    }
+  ]}
+/>
 
 ---
 

diff --git a/www/apps/resources/app/architectural-modules/notification/page.mdx b/www/apps/resources/app/architectural-modules/notification/page.mdx
@@ -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"
+      }
+    }
+  ]}
+/>
 
 ---
 

diff --git a/www/apps/resources/app/architectural-modules/page.mdx b/www/apps/resources/app/architectural-modules/page.mdx
@@ -1,4 +1,4 @@
-import { ChildDocs, CardList } from "docs-ui"
+import { CardList } from "docs-ui"
 
 export const metadata = {
   title: `Architectural Modules`,

diff --git a/www/apps/resources/app/architectural-modules/workflow-engine/page.mdx b/www/apps/resources/app/architectural-modules/workflow-engine/page.mdx
@@ -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"
+      }
+    }
+  ]}
+/>
diff --git a/www/apps/resources/app/commerce-modules/inventory/inventory-in-flows/page.mdx b/www/apps/resources/app/commerce-modules/inventory/inventory-in-flows/page.mdx
@@ -10,6 +10,12 @@ This document explains how the Inventory Module is used within the Medusa applic
 
 When a product variant is created and its `manage_inventory` property's value is `true`, the Medusa application creates an inventory item associated with that product variant.
 
+<Note title="Tip">
+
+This flow is implemented within the [createProductVariantsWorkflow](/references/medusa-workflows/createProductVariantsWorkflow)
+
+</Note>
+
 ![A diagram showcasing how the Inventory Module is used in the product variant creation form](https://res.cloudinary.com/dza7lstvk/image/upload/v1709661511/Medusa%20Resources/inventory-product-create_khz2hk.jpg)
 
 ---
@@ -18,6 +24,12 @@ When a product variant is created and its `manage_inventory` property's value is
 
 When a product variant with `manage_inventory` set to `true` is added to cart, the Medusa application checks whether there's sufficient stocked quantity. If not, an error is thrown and the product variant won't be added to the cart.
 
+<Note title="Tip">
+
+This flow is implemented within the [addToCartWorkflow](/references/medusa-workflows/addToCartWorkflow)
+
+</Note>
+
 ![A diagram showcasing how the Inventory Module is used in the add to cart flow](https://res.cloudinary.com/dza7lstvk/image/upload/v1709711645/Medusa%20Resources/inventory-cart-flow_achwq9.jpg)
 
 ---
@@ -26,6 +38,12 @@ When a product variant with `manage_inventory` set to `true` is added to cart, t
 
 When an order is placed, the Medusa application creates a reservation item for each product variant with `manage_inventory` set to `true`.
 
+<Note title="Tip">
+
+This flow is implemented within the [completeCartWorkflow](/references/medusa-workflows/completeCartWorkflow)
+
+</Note>
+
 ![A diagram showcasing how the Inventory Module is used in the order placed flow](https://res.cloudinary.com/dza7lstvk/image/upload/v1709712005/Medusa%20Resources/inventory-order-placed_qdxqdn.jpg)
 
 ---
@@ -38,6 +56,12 @@ When an item in an order is fulfilled and the associated variant has its `manage
 - Resets the `reserved_quantity` to `0`.
 - Deletes the associated reservation item.
 
+<Note title="Tip">
+
+This flow is implemented within the [createOrderFulfillmentWorkflow](/references/medusa-workflows/createOrderFulfillmentWorkflow)
+
+</Note>
+
 ![A diagram showcasing how the Inventory Module is used in the order fulfillment flow](https://res.cloudinary.com/dza7lstvk/image/upload/v1709712390/Medusa%20Resources/inventory-order-fulfillment_o9wdxh.jpg)
 
 ---
@@ -46,6 +70,12 @@ When an item in an order is fulfilled and the associated variant has its `manage
 
 When an item in an order is returned and the associated variant has its `manage_inventory` property set to `true`, the Medusa application increments the `stocked_quantity` of the inventory item's level with the returned quantity.
 
+<Note title="Tip">
+
+This flow is implemented within the [confirmReturnReceiveWorkflow](/references/medusa-workflows/confirmReturnReceiveWorkflow)
+
+</Note>
+
 ![A diagram showcasing how the Inventory Module is used in the order return flow](https://res.cloudinary.com/dza7lstvk/image/upload/v1709712457/Medusa%20Resources/inventory-order-return_ihftyk.jpg)
 
 ### Dismissed Returned Items