docs: integrate Vale for documentation linting (#2242)

* 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
+1 -1
View File
@@ -1,6 +1,6 @@
# CORS issues
If you are experiencing connection issues when trying to access your Medusa server from a storefront, it is most likely due to CORS issues.
If you are experiencing connection issues when trying to access your Medusa server from a storefront, it is most likely due to Cross-Origin Resource Sharing (CORS) issues.
You might see a log in your browser console, that looks like this:
@@ -1,6 +1,6 @@
# Documentation Error
If you have installed the dependencies in the root of the Medusa repository (i.e., if you have a `node_modules` directory at the root of the Medusa repository), this will cause an error when running the documentation website.
If you have installed the dependencies in the root of the Medusa repository (that is, if you have a `node_modules` directory at the root of the Medusa repository), this will cause an error when running the documentation website.
This is because the content resides in `docs/content`. When that content is being imported from there, a mix up can happen between the dependencies in the root of the Medusa repository and the dependencies in `www/docs` which causes an `invalid hook call` error.
@@ -15,4 +15,4 @@ medusa user -e some@email.com -p somepassword
## Additional Resources
Learn more about our CLI tool in the [CLI reference](../cli/reference.md).
Learn more about Medusa's CLI tool in the [CLI reference](../cli/reference.md).