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

docs: general fixes and improvements (#7918)

Browse Source 
* 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
This commit is contained in:
Shahed Nasser
2024-07-04 17:26:03 +03:00
committed by GitHub
parent 32982e708a
commit 964927b597
149 changed files with 1676 additions and 3008 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/app/architectural-modules/notification/local/page.mdx
+3 -6
View File
@@ -33,7 +33,7 @@ Only one provider can be defined for a channel.
</Note>
```js title="medusa-config.js"
const { Modules } = require("@medusajs/modules-sdk")
import { Modules } from "@medusajs/utils"
// ...
@@ -47,12 +47,9 @@ module.exports = defineConfig({
// ...
{
resolve: "@medusajs/notification-local",
id: "local",
options: {
config: {
local: {
channels: ["email"],
},
},
channels: ["email"],
},
},
],
www/apps/resources/app/architectural-modules/notification/page.mdx
+3 -6
View File
@@ -31,7 +31,7 @@ When you send a notification, you specify the channel to send it through, such a
For example:
```js title="medusa-config.js" highlights={[["19"]]}
const { Modules } = require("@medusajs/modules-sdk")
import { Modules } from "@medusajs/utils"
// ...
@@ -46,12 +46,9 @@ module.exports = {
// ...
{
resolve: "@medusajs/notification-local",
id: "notification",
options: {
config: {
local: {
channels: ["email"],
},
},
channels: ["email"],
},
},
],
www/apps/resources/app/architectural-modules/notification/send-notification/page.mdx
+4 -1
View File
@@ -33,7 +33,10 @@ export const highlights = [
]
```ts title="src/subscribers/product-created.ts" highlights={highlights} collapsibleLines="1-7" expandButtonLabel="Show Imports"
import type { SubscriberArgs, SubscriberConfig } from "@medusajs/medusa"
import type {
SubscriberArgs,
SubscriberConfig,
} from "@medusajs/medusa"
import { ModuleRegistrationName } from "@medusajs/utils"
import { INotificationModuleService } from "@medusajs/types"
www/apps/resources/app/architectural-modules/notification/sendgrid/page.mdx
+9 -9
View File
@@ -35,7 +35,7 @@ Only one provider can be defined for a channel.
</Note>
```js title="medusa-config.js"
const { Modules } = require("@medusajs/modules-sdk")
import { Modules } from "@medusajs/utils"
// ...
@@ -49,14 +49,11 @@ module.exports = defineConfig({
// ...
{
resolve: "@medusajs/notification-sendgrid",
id: "sendgrid",
options: {
config: {
sendgrid: {
channels: ["email"],
api_key: process.env.SENDGRID_API_KEY,
from: process.env.SENDGRID_FROM,
},
},
channels: ["email"],
api_key: process.env.SENDGRID_API_KEY,
from: process.env.SENDGRID_FROM,
},
},
],
@@ -130,7 +127,10 @@ export const highlights = [
]
```ts title="src/subscribers/product-created.ts" highlights={highlights} collapsibleLines="1-7" expandButtonLabel="Show Imports"
import type { SubscriberArgs, SubscriberConfig } from "@medusajs/medusa"
import type {
SubscriberArgs,
SubscriberConfig,
} from "@medusajs/medusa"
import { ModuleRegistrationName } from "@medusajs/utils"
import { INotificationModuleService } from "@medusajs/types"