docs: general fixes and improvements (#7918)

* docs improvements and changes * updated module definition * modules + dml changes * fix build * fix vale error * fix lint errors * fixes to stripe docs * fix condition * fix condition * fix module defintion * fix checkout * disable UI action * change oas preview action * flatten provider module options * fix lint errors * add module link docs * pr comments fixes * fix vale error * change node engine version * links -> linkable * add note about database name * small fixes * link fixes * fix response code in api reference * added migrations step
2024-07-04 17:26:03 +03:00
parent 32982e708a
commit 964927b597
149 changed files with 1676 additions and 3008 deletions
@@ -135,10 +135,11 @@ Create the file `src/modules/my-cache/index.ts` with the following content:

 ```ts title="src/modules/my-cache/index.ts"
 import MyCacheService from "./service"
+import { Module } from "@medusajs/utils"

-export default {
+export default Module("my-cache", {
  service: MyCacheService,
-}
+})
 ```

 This exports the module's definition, indicating that the `MyCacheService` is the main service of the module.
@@ -152,7 +153,7 @@ To use your Cache Module, add it to the `modules` object exported as part of the
 For example:

 ```js title="medusa-config.js"
-const { Modules } = require("@medusajs/modules-sdk")
+import { Modules } from "@medusajs/utils"

 // ...

@@ -31,7 +31,7 @@ npm install @medusajs/cache-inmemory
 Next, add the module into the `modules` property of the exported object in `medusa-config.js`:

 ```js title="medusa-config.js"
-const { Modules } = require("@medusajs/modules-sdk")
+import { Modules } from "@medusajs/utils"

 // ...

@@ -31,7 +31,7 @@ export const highlights = [
 ]

 ```js title="medusa-config.js" highlights={highlights}
-const { Modules } = require("@medusajs/modules-sdk")
+import { Modules } from "@medusajs/utils"

 // ...