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/endpoints/add-admin.md
+2 -2
View File
@@ -53,7 +53,7 @@ import cors from "cors"
import { projectConfig } from "../../medusa-config"
```
Then, create an object that will hold the CORS configurations:
Then, create an object that will hold the Cross-Origin Resource Sharing (CORS) configurations:
```js
const corsOptions = {
@@ -204,7 +204,7 @@ const user = await userService.retrieve(id)
### Route Parameters
The routes you create receive 2 parameters. The first one is the absolute path to the root directory that your server is running from. The second one is an object that has your plugin's options. If your API route is not implemented in a plugin, then it will be an empty object.
The routes you create receive two parameters. The first one is the absolute path to the root directory that your server is running from. The second one is an object that has your plugin's options. If your API route is not implemented in a plugin, then it will be an empty object.
```js
export default (rootDirectory, pluginOptions) => {
docs/content/advanced/backend/endpoints/add-storefront.md
+2 -2
View File
@@ -53,7 +53,7 @@ import cors from "cors"
import { projectConfig } from "../../medusa-config"
```
Then, create an object that will hold the CORS configurations:
Then, create an object that will hold the Cross-Origin Resource Sharing (CORS) configurations:
```js
const corsOptions = {
@@ -203,7 +203,7 @@ const customer = await customerService.retrieve(id)
### Route Parameters
The routes you create receive 2 parameters. The first one is the absolute path to the root directory that your server is running from. The second one is an object that has your plugin's options. If your API route is not implemented in a plugin, then it will be an empty object.
The routes you create receive two parameters. The first one is the absolute path to the root directory that your server is running from. The second one is an object that has your plugin's options. If your API route is not implemented in a plugin, then it will be an empty object.
```js
export default (rootDirectory, pluginOptions) => {