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

docs: integrate Vale for documentation linting (#2242)

Browse Source 
* added value rules

* resolved errors raised by vale

* added github action

* fixes to github action

* added details in contribution guidelines

* added rule for numbers

* limited checks to errors
This commit is contained in:
Shahed Nasser
2022-09-22 13:12:09 +03:00
committed by GitHub
parent d0d789b6d4
commit 6adaf56c73
103 changed files with 2408 additions and 832 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/advanced/backend/notification/overview.md
+2 -2
View File
@@ -6,7 +6,7 @@ This document gives an overview of the notification architecture and how it work
Medusa provides a Notification API to mainly handle sending and resending notifications when an event occurs. For example, sending an email to the customer when they place an order.
The Notification architecture is made up of 2 main components: the Notification Provider and the Notification. Simply put, the Notification Provider handles the sending and resending of a Notification.
The Notification architecture is made up of two main components: the Notification Provider and the Notification. Simply put, the Notification Provider handles the sending and resending of a Notification.
## Notification Provider
@@ -48,7 +48,7 @@ A Notification also represents a resent notification. So, when a notification is
### Notification Entity Overview
The 2 most important properties in the `Notification` entity are the `to` and `data` properties.
The two most important properties in the `Notification` entity are the `to` and `data` properties.
The `to` property is a string that represents the receiver of the Notification. For example, if the Notification was sent to an email address, the `to` property holds the email address the Notification was sent to.