diff --git a/docs/contributing-guide/api-documentation.md b/docs/contributing-guide/api-documentation.md index 97b7db74..696cba53 100644 --- a/docs/contributing-guide/api-documentation.md +++ b/docs/contributing-guide/api-documentation.md @@ -2,7 +2,7 @@ title: "API Documentation" --- -Chatwoot uses [Swagger 2.0](https://swagger.io/specification/v2/) for documenting the API. +Chatwoot uses [Swagger 2.0](https://swagger.io/specification/v2/) for documenting APIs. ### File/Directory structure @@ -25,4 +25,4 @@ rake swagger:build ### Testing -In development mode, `http://localhost:3000/swagger` is available to test whether the API changes has been updated. +In development mode, `http://localhost:3000/swagger` is available to test whether the API changes are updated. diff --git a/docs/contributing-guide/chatwoot-platform-apis.md b/docs/contributing-guide/chatwoot-platform-apis.md index a127439f..2d77a835 100644 --- a/docs/contributing-guide/chatwoot-platform-apis.md +++ b/docs/contributing-guide/chatwoot-platform-apis.md @@ -16,11 +16,11 @@ To create a platform app, follow these steps: ![Super Admin Portal](./images/platform-app/super_admin.png) -2. Click on the "New platform app" button. +2. Click the "New platform app" button. ![Platform Apps Home](./images/platform-app/platform-home.png) -3. Fill in the platform app name and click the "Create" button. +3. Enter the platform app name and click **Create Platform app**. ![Create Platform App](./images/platform-app/platform-create.png) @@ -30,7 +30,7 @@ To create a platform app, follow these steps: ## Using the Access Token -The `access_token` is required to authenticate all API requests. Please use the Postman collection to test these APIs. +The `access_token` is required to authenticate all API requests. Use the Postman collection to test these APIs. ### Testing the APIs diff --git a/docs/contributing-guide/common-errors.md b/docs/contributing-guide/common-errors.md index 06e4c31d..5c22d861 100644 --- a/docs/contributing-guide/common-errors.md +++ b/docs/contributing-guide/common-errors.md @@ -11,7 +11,7 @@ The following are some of the errors you might encounter while setting up the pr ArgumentError: invalid uri scheme ``` -This is an error thrown from redis connector. You might not have setup the redis environment variables properly. Please refer to dependencies section to install redis-server and [Configure Redis URL](https://www.chatwoot.com/docs/environment-variables) in the environment-variables section. +This is an error thrown from redis connector. You might not have setup the redis environment variables properly. Refer to dependencies section to install redis-server and [Configure Redis URL](https://www.chatwoot.com/docs/environment-variables) in the environment-variables section. ### pg gem Installation error diff --git a/docs/contributing-guide/environment-variables.md b/docs/contributing-guide/environment-variables.md index 69cc55f8..e08ddbc7 100644 --- a/docs/contributing-guide/environment-variables.md +++ b/docs/contributing-guide/environment-variables.md @@ -2,7 +2,7 @@ title: 'Environment variables' --- -For a complete set of production environment variables, please refer to [Production Environment Variables Guide](/docs/self-hosted/configuration/environment-variables) +For a complete set of production environment variables, Refer to [Production Environment Variables Guide](/docs/self-hosted/configuration/environment-variables) In addition to the above variables, you can use the following variables in development mode. diff --git a/docs/contributing-guide/line-channel-setup.md b/docs/contributing-guide/line-channel-setup.md index c099d8e0..f843e46b 100644 --- a/docs/contributing-guide/line-channel-setup.md +++ b/docs/contributing-guide/line-channel-setup.md @@ -3,16 +3,16 @@ sidebar_label: "Line App" title: "Setup Line app integration on your local machine" --- -Please follow the steps if you are trying to work with the Line integration on your local machine. +To work with the Line integration on your local machine, do the following: - Start a Ngrok server listening at port `3000` or the port you will be running the Chatwoot installation. - Update the .env variable FRONTEND_URL in Chatwoot with the `https` version of the Ngrok URL. - Start the Chatwoot server and create a new Line channel with the below values obtained from [Line Developer Console](https://developers.line.biz/console) under the "Messaging API" channel. -1. Channel Name -2. LINE Channel ID -3. LINE Channel Secret -4. LINE Channel Token + - Channel Name + - LINE Channel ID + - LINE Channel Secret + - LINE Channel Token After creating the channel, Chatwoot will provide a webhook URL for the channel. You can configure this webhook url in the [Line Developer Console](https://developers.line.biz/console) under the "Messaging API" channel. diff --git a/docs/contributing-guide/project-setup.md b/docs/contributing-guide/project-setup.md index a7139784..8d74c96b 100644 --- a/docs/contributing-guide/project-setup.md +++ b/docs/contributing-guide/project-setup.md @@ -3,7 +3,7 @@ sidebar_label: "Setup Guide" title: "Project Setup" --- -This guide will help you to setup and run Chatwoot in development mode. Please make sure you have completed the environment setup. +This guide will help you to setup and run Chatwoot in development mode. Ensure you have completed the environment setup. ### Clone the repo diff --git a/docs/contributing-guide/security-reports.md b/docs/contributing-guide/security-reports.md index 8a9cf7de..8c5b2e94 100644 --- a/docs/contributing-guide/security-reports.md +++ b/docs/contributing-guide/security-reports.md @@ -16,7 +16,7 @@ If you have any questions about the process, contact security@chatwoot.com. Please try your best to describe a clear and realistic impact for your report, and please don't open any public issues on GitHub or social media; we're doing our best to respond through Github as quickly as possible. -> Note: Please use the email for questions related to the process. Disclosures should be done via [Github](https://github.com/chatwoot/chatwoot/security/advisories/new). +> Note: Use the email for questions related to the process. Disclosures should be done via [Github](https://github.com/chatwoot/chatwoot/security/advisories/new). ## Supported versions diff --git a/docs/contributing-guide/telegram-channel-setup.md b/docs/contributing-guide/telegram-channel-setup.md index ae785115..2d31d341 100644 --- a/docs/contributing-guide/telegram-channel-setup.md +++ b/docs/contributing-guide/telegram-channel-setup.md @@ -3,7 +3,7 @@ sidebar_label: "Telegram App" title: "Setup Telegram app integration on your local machine" --- -Please follow the steps if you are trying to work with the Telegram integration on your local machine. +To work with the Telegram integration on your local machine, do the following: - Start a Ngrok server listening at port `3000` or the port you will be running the Chatwoot installation. - Update the .env variable FRONTEND_URL in Chatwoot with the `https` version of the Ngrok URL. diff --git a/docs/contributing-guide/translation-guidelines.md b/docs/contributing-guide/translation-guidelines.md index 0ab8b531..391eda77 100644 --- a/docs/contributing-guide/translation-guidelines.md +++ b/docs/contributing-guide/translation-guidelines.md @@ -9,8 +9,7 @@ Chatwoot uses American English by default. Each and every string available in Ch ## How do I see the strings that needs to be translated? -In the codebase the string are placed in the following locations. - +In the codebase, the string are placed in the following locations: - `app/javascript/dashboard/i18n` - The strings related to the agent dashboard - `app/javascript/widget/i18n` - The strings related to the web widget - `app/javascript/survey/i18n` - The strings related to CSAT surveys @@ -34,7 +33,7 @@ At Chatwoot, we prefer to use formal form of language wherever possible. For ins Proofreading helps ensure the accuracy and consistency of translations. Right now, the translations are being accepted without a proof reading step. This would be changed in the future as an when there are more contributors on each language. -*Note:* If you are the only person contributing to a language, make sure that you inform any of the Chatwoot members to gain access to manage the language. +*Note:* If you are the only person contributing to a language, ensure that you inform any of the Chatwoot members to gain access to manage the language. ### Releasing a new language