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/usage/configurations.md
+6 -6
View File
@@ -71,7 +71,7 @@ npm install dotenv --save
## Database Configuration
Medusa supports 2 database types: SQLite and PostgreSQL.
Medusa supports two database types: SQLite and PostgreSQL.
:::tip
@@ -81,7 +81,7 @@ You can use SQLite for development purposes, however, it’s recommended to use
### SQLite Configurations
For SQLite you mainly need 2 configurations:
For SQLite you mainly need two configurations:
```jsx
module.exports = {
@@ -103,7 +103,7 @@ Before getting started with configuring PostgreSQL, you should have created a Po
:::
For PostgreSQL you mainly need 2 configurations:
For PostgreSQL you mainly need two configurations:
```jsx
module.exports = {
@@ -181,9 +181,9 @@ You can learn more about Subscribers and events in the [Subscriber documentation
:::
## JSON Web Token (JWT) Secret
## JWT Secret
Medusa uses JWT to handle user authentication. To set the JWT secret:
Medusa uses JSON Web Token (JWT) to handle user authentication. To set the JWT secret:
```jsx
module.exports = {
@@ -353,6 +353,6 @@ It is recommended to use environment variables to store values of options instea
## What’s Next 🚀
- Check out our [Next.js](../starters/nextjs-medusa-starter.md) and [Gatsby](../starters/gatsby-medusa-starter.md) starter storefronts.
- Check out the [Next.js](../starters/nextjs-medusa-starter.md) and [Gatsby](../starters/gatsby-medusa-starter.md) starter storefronts.
- Install the [Medusa admin](../admin/quickstart.md).
- Learn about [deploying the Medusa server](../deployments/server/index.mdx).
docs/content/usage/create-medusa-app.mdx
+4 -4
View File
@@ -3,15 +3,15 @@ import TabItem from '@theme/TabItem';
# Use create-medusa-app
In this document, you’ll learn how to use `create-medusa-app` to create a Medusa project with the 3 main components of Medusa.
In this document, you’ll learn how to use `create-medusa-app` to create a Medusa project with the three main components of Medusa.
## Overview
As explained in the [Introduction guide](../introduction.md), Medusa is composed of 3 different components: the headless server, the storefront, and the admin dashboard.
As explained in the [Introduction guide](../introduction.md), Medusa is composed of three different components: the headless server, the storefront, and the admin dashboard.
Medusa provides the necessary tools and resources to set up the 3 components separately. This ensures that developers have full freedom to choose their tech stack, as they can choose any framework for the storefront and admin dashboard.
Medusa provides the necessary tools and resources to set up the three components separately. This ensures that developers have full freedom to choose their tech stack, as they can choose any framework for the storefront and admin dashboard.
However, if you’re interested in using Medusa’s starters for the 3 components, you can easily make use of the `create-medusa-app` command instead of creating each separately.
However, if you’re interested in using Medusa’s starters for the three components, you can easily make use of the `create-medusa-app` command instead of creating each separately.
When you run the `create-medusa-app` command, you’ll install a Medusa server, a Medusa admin, and optionally a storefront at the same time.