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
@@ -107,7 +107,7 @@ To delete a denomination:
:::info
You can add up to 10 images for a Gift Card.
You can add up to ten images for a Gift Card.
:::
+3 -3
View File
@@ -11,7 +11,7 @@ This user guide is intended to help users learn how they can use the Medusa admi
:::tip
If you dont have a Medusa admin yet, you can check [our live demo](https://demo.medusajs.com/)!
If you dont have a Medusa admin yet, you can check [the live demo](https://demo.medusajs.com/)!
:::
@@ -69,8 +69,8 @@ At the top right, youll find an avatar icon. By clicking this icon, youll
![Quick Actions Dropdown](https://i.imgur.com/YgVKTLH.png)
### Need Help?
### Need Help
At the top right, youll find a <UiIcon lightIcon="https://i.imgur.com/CrABja9.png" darkIcon="https://i.imgur.com/cgeX2hP.png" alt="question mark" /> icon. When you click on this icon, a form will pop up. You can use this form to send the Medusa team a message asking for help. Our team usually responds in a few hours on business days.
At the top right, youll find a <UiIcon lightIcon="https://i.imgur.com/CrABja9.png" darkIcon="https://i.imgur.com/cgeX2hP.png" alt="question mark" /> icon. When you click on this icon, a form will pop up. You can use this form to send the Medusa team a message asking for help. The Medusa team usually responds in a few hours on business days.
![Get Help Form](https://i.imgur.com/8Fpa0gr.png)
+1 -1
View File
@@ -136,7 +136,7 @@ To cancel a claims fulfillment:
1. Open the order details page.
2. Scroll down to the Fulfillment section.
3. Find the fulfillment you want to cancel. A claims fulfillments title should be prefixed with “Claim fulfillment”.
3. Find the fulfillment you want to cancel. A claims fulfillments title should be prefixed with “Claim fulfillment”.
4. Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon next to it.
5. Click on Cancel Fulfillment in the dropdown.
6. Confirm canceling the fulfillment by clicking the “Yes, confirm” button in the pop-up.
+1 -1
View File
@@ -14,7 +14,7 @@ Taxes are calculated for products and shipping methods on checkout. Medusa provi
---
## How are Taxes Created?
## How are Taxes Created
Once a region is created, a default tax rate is created for that region. You can specify the rate and code of the tax rate during the creation of the region.
+1 -1
View File
@@ -58,6 +58,6 @@ To delete a tax rate:
:::info
Default tax rates cant be deleted. If you dont want to apply any taxes in a region, you can instead set the default tax rate to 0.
Default tax rates cant be deleted. If you dont want to apply any taxes in a region, you can instead set the default tax rate to zero.
:::