feat(docs): proof read articles

Author: mittalyashu

docs/architecture/api.md

@@ -1,13 +1,13 @@
 ---
 title: APIs
-description: At its core, LogChimp is powered by RESTful JSON API.
+description: LogChimp's foundation lies in its powerfull RESTful JSON API.
 slug: /docs/architecture/api
 ---
 
-At its core, LogChimp is a RESTful JSON API - designed to track, manage, engage, and analyze user feedback with ease.
+LogChimp's foundation lies in its RESTful JSON API, designed to effortlessly track, manage, engage, and analyze user feedback.
 
-To know more about [LogChimp APIs](/api).
+To learn more about [LogChimp APIs](/api).
 
 ### Versioning
 
-Each major version of LogChimp ships with multiple versions of the APIs. We maintain a stable APIs so that you can be sure about depending on them in production.
+Each major version of LogChimp ships with multiple versions of the APIs. We maintain stable APIs so that you can confidently depend on them in production.

docs/architecture/readme.md

@@ -1,23 +1,25 @@
 ---
 title: Architecture
-description: How LogChimp works with it's architecture?
+description: Understanding LogChimp's architecture
 slug: /docs/architecture
 ---
 
-LogChimp is an independent, built on a modern technology stack of Node.js for powering its robust JSON API, stand-alone system with dependency only on the database (PostgreSQL) as a data storage layer, with a beautiful and rich client app written in Vue.js including a powerful dashboard - find out more.
+LogChimp is an independent system built on a modern technology stack. It utilizes Node.js to power its robust JSON API and relies solely on the PostgreSQL database as its data storage layer. Complemented by a beautifully crafted client app written in Vue.js with Typescript, LogChimp offers a powerful dashboard, providing users with a comprehensive experience.
 
-A high-level view of LogChimp's architecture is as shown:
+A high-level overview of LogChimp's architecture is shown below:
 
 ![LogChimp Architecture](../../images/docs/architecture/architecture.png)
 
-These five areas work together to make every LogChimp site function smoothly.
+These five components work together seamlessly to ensure the smooth functioning of every LogChimp site:
 
 1. [Robust REST APIs](/docs/architecture/api)
 2. Beautiful Vue.js client app
 3. Powerful Dashboard
 4. PostgreSQL Database
 5. Disk storage space
 
-## Node environment
+## Node Environment
 
-LogChimp supports three environments: `development`, `testing`, `production`. A public LogChimp site should always run in **production** mode, development is used for building LogChimp locally and testing is only used in CI/CD to run tests.
+LogChimp supports three environments: `development`, `testing`, and `production`.
+
+Public LogChimp sites should always run in **production** mode, while the `development` environment is used for the local development of LogChimp. The `testing` environment is exclusively employed in CI/CD pipelines for running tests.

docs/cli/commands.md

@@ -1,20 +1,20 @@
 ---
 title: Commands
-description: Below are the available LogChimp CLI commands. You can always run `logchimp --help` or `logchimp help [COMMAND]` to get more detail.
+description: Explore the available LogChimp CLI commands below. For detailed information on each command, you can always run `logchimp --help` or `logchimp help [COMMAND]`.
 slug: /docs/cli/commands
 ---
 
 import { Alert } from "../../../src/components/Documentation/Alert.tsx"
 
 <Alert type="tip">
-  Each command is documented in detail on its own page.
+  Each command is thoroughly documented on its own page.
 </Alert>
 
 - [logchimp help](/docs/cli/help)
 
 ### Config
 
-Command for managing logchimp configuration.
+Commands for managing LogChimp configuration.
 
 - [logchimp config](/docs/cli/config)
 - [logchimp config:generate](/docs/cli/config/generate)

docs/cli/config/generate.md

@@ -10,35 +10,34 @@ USAGE
 
 EXAMPLES
   $ logchimp config:generate --force
-  $ logchimp config:generate --dbhost=localhost --dbuser=username
-  --dbname=database --dbport=5432
+  $ logchimp config:generate --dbhost=localhost --dbuser=username --dbname=database --dbport=5432
 ```
 
 ### Options
 
-- `-f` or `--force` - Overwrite the existing configuration file, if present.
+- `-f` or `--force` - Overwrite the existing configuration file if present
 - `-i` or `--interactive` - Use interactive mode
-- `--env` - Generates `logchimp.config.json` file using environment variable.
+- `--env` - Generate a `logchimp.config.json` file using environment variables
 
 **Server**
 
 - `--local` - Run LogChimp for local development/testing
 - `--port=port` - [default: 3000] Server port to listen on
-- `--secretKey=secretKey` - Secret key for password validation _(default auto generate random string)_
+- `--secretKey=secretKey` - Secret key for password validation _(default auto-generates a random string)_
 
 **Database**
 
 - `--dbhost=dbhost` - Database host
 - `--dbname=dbname` - Database name
-- `--dbpass=dbpass` - Database password _(default auto generate random password)_
+- `--dbpass=dbpass` - Database password _(default auto-generates a random password)_
 - `--dbport=dbport` - [default: 5432] Database port
-- `--[no-]dbssl` - Enable SSL for database _(default true for production)_
+- `--[no-]dbssl` - Enable SSL for the database _(default true for production)_
 - `--dbuser=dbuser` - Database username
 
 **Mail**
 
 - `--mailhost=mailhost` - Mail service SMTP hostname
-- `--mailpass=mailpass` - Mail service SMTP password _(default auto generate random password)_
+- `--mailpass=mailpass` - Mail service SMTP password _(default auto-generates a random password)_
 - `--mailport=mailport` - [default: 587] Mail service SMTP port
-- `--mailservice=mailservice` - Mail service e.g. MailGun
+- `--mailservice=mailservice` - Mail service e.g., MailGun
 - `--mailuser=mailuser` - Mail service SMTP username

docs/cli/config/get.md

@@ -1,6 +1,6 @@
 ---
 title: logchimp config:get
-description: Get a specific value from the configuration file.
+description: Retrieve a specific value from the configuration file.
 slug: /docs/cli/config/get
 ---
 
@@ -9,10 +9,10 @@ USAGE
   $ logchimp config:get [flags]
 
 EXAMPLES
-  $ logchimp config:get --key database.port
-  $ logchimp config:get --key server.secretKey
+  $ logchimp config:get --key=database.port
+  $ logchimp config:get --key=server.secretKey
 ```
 
 ### Options
 
-- `-k` or `--key=key` - key of which you want to get the value
+- `-k` or `--key=key` - Key for retrieving the value

docs/cli/config/readme.md

@@ -1,10 +1,10 @@
 ---
 title: logchimp config
-description: Generate or modify the LogChimp configuration using `config` command.
+description: Generate or modify LogChimp configuration using the `config` command.
 slug: /docs/cli/config
 ---
 
-The `config` commands contains multiple sub-commands.
+The `config` command contains multiple sub-commands.
 
 ```bash
 USAGE

docs/cli/config/set.md

@@ -11,5 +11,5 @@ USAGE
 
 ### Options
 
-- `-k` or `--key=key` - name to print
-- `-v` or `--value=value` - name to print
+- `-k` or `--key=key` - Key to set in the configuration file
+- `-v` or `--value=value` - Value to set in the configuration file

docs/cli/help.md

@@ -1,10 +1,10 @@
 ---
 title: logchimp help
-description: Use the help command to access the list of possible `logchimp` commands when required.
+description: Use the help command to access the list of possible `logchimp` commands when needed.
 slug: /docs/cli/help
 ---
 
-This command is your port of call when you want to discover a list of available commands in the LogChimp CLI.
+This command is your go-to when you want to discover a list of available commands in the LogChimp CLI.
 
 ```bash
 CLI Tool for LogChimp

docs/cli/readme.md

@@ -1,16 +1,16 @@
 ---
 title: CLI
-description: An all-in-one tool to help you configure and making it super easy to spin up a new LogChimp site.
+description: An all-in-one tool to help you configure and make it super easy to spin up a new LogChimp site.
 slug: /docs/cli
 ---
 
-We understand that some users are going to want more flexibility, so the CLI has a whole set of flags and options that allow you to break the steps down and adjust what they do.
+We understand that some users are going to want more flexibility, so the CLI has a whole set of flags and options that allow you to break down the steps and adjust what they do.
 
 If you have any suggestions or find bugs 🐞, head over to the [LogChimp CLI GitHub repository](https://github.com/logchimp/logchimp-cli) and let us know.
 
 ## Install
 
-LogChimp CLI is an npm package that can be installed via either npm or yarn.
+LogChimp CLI is an npm package that can be installed via either npm or yarn or pnpm.
 
 ```bash
 npm install -g logchimp-cli

docs/config.md

@@ -1,33 +1,33 @@
 ---
 title: Configuration
-description: Step by step guide for you to configure LogChimp site using `logchimp.config.json` file.
+description: Step-by-step guide for configuring LogChimp site using `logchimp.config.json` file.
 slug: /docs/config
 ---
 
 import { Alert } from "../../src/components/Documentation/Alert.tsx"
 
 ## Overview
 
-There are some configuration options which is pre-filled by default at installation process via [one-click deploy](/docs/install) button, and other options needs to be configured manually, _for example secret credentials_.
+Some configuration options are pre-filled by default during the installation process via the [one-click deploy](/docs/install) button, while others need to be configured manually, such as secret credentials.
 
 There are two ways to configure your LogChimp site:
 
-1. `logchimp.config.json` file
-2. Environment variables
+1. Using the `logchimp.config.json` file
+2. Using environment variables
 
 <Alert type="tip">
-Configuring your LogChimp site is one time task and is not required for you to update often, unless you're rotating your secret credentials.
+Configuring your LogChimp site is a one-time task and is not required to be updated frequently, unless you're rotating your secret credentials.
 </Alert>
 
 ## `logchimp.config.json` file
 
 A custom configuration file must be a valid JSON file located in the root folder.
 
 <Alert type="warning">
-The configuration below is just an example and not recommended for production use.
+The configuration below is just an example and is not recommended for production use.
 </Alert>
 
-The two required options are `database` and `server` which are configurated during installation process.
+The two required options are `database` and `server`, which are configured during the installation process.
 
 ```json lines
 {
@@ -49,7 +49,7 @@ The two required options are `database` and `server` which are configurated duri
 
 ### Mail
 
-LogChimp uses SMPT connection for sending emails programmatically.
+LogChimp uses SMTP connection for sending emails programmatically.
 
 ```json lines
 {
@@ -64,34 +64,34 @@ LogChimp uses SMPT connection for sending emails programmatically.
 }
 ```
 
-## Environment variables
+## Environment Variables
 
 **SERVER**
 
-- `LOGCHIMP_SECRET_KEY`: Railway provides an easy way to generate 32-char secret key, by pressing `Command + K` (on MacOS) or `Ctrl + K` (on windows). Of course, you can provide your own secret key as well.
+- `LOGCHIMP_SECRET_KEY`: Railway provides an easy way to generate a 32-character secret key by pressing `Command + K` (on MacOS) or `Ctrl + K` (on Windows). Of course, you can provide your own secret key as well.
 - `PORT`: Please do not change the pre-filled value.
-- `LOGCHIMP`: This tells LogChimp to use environment variables instead of [configuration file](/docs/config). Please do not change the pre-filled value.
-- `LOGCHIMP_THEME_STANDALONE`: LogChimp allows you to run on single port or split API and theme. If you're using Railway deploy button, you can leave the value to `false`.
+- `LOGCHIMP`: This tells LogChimp to use environment variables instead of a [configuration file](/docs/config). Please do not change the pre-filled value.
+- `LOGCHIMP_THEME_STANDALONE`: LogChimp allows you to run on a single port or split API and theme. If you're using the Railway deploy button, you can leave the value as `false`.
 
 **DATABASE**
 
-You can use your own PostgreSQL database or use PostgreSQL plugin provided by Railway. If you're using Railway plugin, you don't have to change the pre-filled values.
+You can use your own PostgreSQL database or use the PostgreSQL plugin provided by Railway. If you're using the Railway database, you don't have to change the pre-filled values.
 
-- `LOGCHIMP_DB_HOST`: Database host; default to `${{ PGHOST }}`
-- `LOGCHIMP_DB_DATABASE`: Database name; default to `${{ PGDATABASE }}`
-- `LOGCHIMP_DB_PORT`: Database port; default to `${{ PGPORT }}`
-- `LOGCHIMP_DB_USER`: Database user; default to `${{ PGUSER }}`
-- `LOGCHIMP_DB_PASSWORD`: Database password; default to `${{ PGPASSWORD }}`
-- `LOGCHIMP_DB_SSL`: Database SSL; default to `true`
+- `LOGCHIMP_DB_HOST`: Database host; defaults to `${{ PGHOST }}`
+- `LOGCHIMP_DB_DATABASE`: Database name; defaults to `${{ PGDATABASE }}`
+- `LOGCHIMP_DB_PORT`: Database port; defaults to `${{ PGPORT }}`
+- `LOGCHIMP_DB_USER`: Database user; defaults to `${{ PGUSER }}`
+- `LOGCHIMP_DB_PASSWORD`: Database password; defaults to `${{ PGPASSWORD }}`
+- `LOGCHIMP_DB_SSL`: Database SSL; defaults to `true`
 
 **MAIL**
 
-You've have to provide SMPT mail authentication details.
+You have to provide SMTP mail authentication details.
 
 - `LOGCHIMP_MAIL_SERVICE`: Name of the email service provider
 - `LOGCHIMP_MAIL_HOST`, `LOGCHIMP_MAIL_USER`, and `LOGCHIMP_MAIL_PASSWORD`
-- `LOGCHIMP_MAIL_PORT`: SMPT port provided by the service provider; default to `587`
+- `LOGCHIMP_MAIL_PORT`: SMTP port provided by the service provider; defaults to `587`
 
-**Does LogChimp support SMPT connection URL?**
+**Does LogChimp support SMTP connection URL?**
 
 No, currently it's not supported. But you're most welcome to [submit a feature request](https://github.com/logchimp/logchimp) anytime.