Merge pull request #21 from web-tech-tw/docs

docs: update

config.sample.yaml

@@ -11,24 +11,24 @@ bridge:
 bridgeProvider:
   # OpenAI
   openai:
-    enable: true
+    enable: false
     # https://github.com/ai-tech-tw/openai
     baseUrl: "https://web-tech-tw.eu.org/openai/v1"
     apiKey: "YourGeminiApiKey"
     chatModel: "gpt-3.5-turbo"
 
   # LINE
   line:
-    enable: true
+    enable: false
     channelAccessToken: "YourChannelAccessToken"
     channelSecret: "YourChannelSecret"
-    useNotify: true
+    useNotify: false
     notifyClientId: "YourClientID"
     notifyClientSecret: "YourClientSecret"
 
   # Matrix
   matrix:
-    enable: true
+    enable: false
     homeserverUrl: "https://matrix.org"
     accessToken: "YourSecretAccessToken"
 

docs/.vitepress/config.ts

@@ -87,14 +87,4 @@ export default defineConfig({
       copyright: "Copyright © 2024 Taiwan Web Technology Promotion Organization (Web Tech TW)"
     }
   },
-  locales: {
-    root: {
-      label: 'English',
-      lang: 'en'
-    },
-    "zh-tw": {
-      label: '正體中文',
-      lang: 'zh-tw',
-    }
-  }
 })

docs/faq.md

@@ -2,4 +2,25 @@
 
 ## What is Arona?
 
-Arona is a bridge for LINE and Matrix, to communicate with the chat room which belongs to both of the different providers.
+Arona is a bridge for multiple messaging platforms.
+It allows you to send messages to different messaging platforms from a single source.
+
+## What can Arona do?
+
+Arona can send messages to multiple messaging platforms, including Discord, Telegram, Matrix, and LINE.
+
+## How do I set up Arona?
+
+You can set up Arona by following the instructions in the [Getting Started](get-started) guide.
+
+## Can I use Arona to send messages to multiple platforms at once?
+
+Yes, you can use Arona to send messages to multiple platforms at once.
+
+## Can I use Arona to send messages to a specific platform?
+
+No, you can't do it currently. But you can disable the providers you don't want to use.
+
+## Can I use Arona to send messages to a specific chat room?
+
+No, you can't do it currently. But you can disable the providers you don't want to use.

docs/integrations/line.md

@@ -8,7 +8,14 @@ It's popular in Asia and has over 200 million active users worldwide.
 
 ## Introduction
 
-LINE Messaging API allows you to add LINE to your app or website to reach your customers. You can respond to messages, send stickers, images, videos, and more.
+The LINE integration allows you to send messages to a LINE chat.
+You can use this integration to send notifications, alerts, and updates to your LINE contacts.
+
+It's powered by LINE Messaging API, which allows you to add LINE to your app or website to reach your customers.
+You can respond to messages, send stickers, images, videos, and more.
+
+There is an LINE Notify integration also, helps you to send notifications from your app to LINE users.
+It will replace the LINE Messaging API with the LINE Notify API to send messages if you enable it.
 
 ## Prerequisites
 

docs/integrations/matrix.md

@@ -5,12 +5,15 @@
 It's a decentralized network that allows you to communicate with other users on the same network.
 
 The [Matrix Bridges](https://matrix.org/ecosystem/bridges) are designed to be interoperable with other messaging platforms,
-Arona is one of them.
-
-You can use the Matrix integration to send messages to a Matrix room from your bot.
+Arona(aka. `Matrix-LINE Bridge (Messaging API)`) is one of them.
 
 ![Matrix](../statics/brands/Matrix.png)
 
+## Introduction
+
+The Matrix integration allows you to send messages to a Matrix room.
+You can use this integration to send notifications, alerts, and updates to your Matrix room.
+
 ## Prerequisites
 
 Before you can set up the Matrix integration, you need to have the following:

docs/integrations/openai.md

@@ -1,30 +1,31 @@
 # OpenAI
 
-OpenAI is a research lab consisting of the for-profit OpenAI LP and the non-profit OpenAI Inc. The organization aims to ensure that artificial general intelligence (AGI) benefits all of humanity. OpenAI is funded by a group of technology executives and investors, including Elon Musk, Reid Hoffman, and Peter Thiel.
+OpenAI module is used to connect to the OpenAI API to generate text, images, and more.
+
+It's compatible with any OpenAI-compatible API service, including the self-hosted OpenAI API.
 
 ![OpenAI](../statics/brands/OpenAI.png)
 
 ## Introduction
 
-The OpenAI integration allows you to interact with the OpenAI API to generate text, images, and more. You can use this integration to create AI-powered workflows that generate content, answer questions, and more.
+The OpenAI integration allows you to interact with the OpenAI API to generate text, images, and more.
+You can use this integration to create AI-powered workflows that generate content, answer questions, and more.
 
 ## Prerequisites
 
 Before you can set up the OpenAI integration, you need to have the following:
 
-- An OpenAI account
-- An OpenAI API key
-- An understanding of how to use the OpenAI API
+- An account from an OpenAI-compatible API service
+- An API key from the service
 
 ## Setting up the integration
 
 To set up the OpenAI integration, you need to create an API key in your OpenAI account. You can do this by following these steps:
 
-1. Log in to your OpenAI account.
-2. Go to the API section of your account.
-3. Click on the "Create API key" button.
-4. Copy the API key into the `apiKey` field (see the [Configure](#configure) section).
-5. Use the API key in your workflows to interact with the OpenAI API.
+1. Log in to your OpenAI-compatible API service account.
+2. Apply for an API key. If you're using the self-hosted OpenAI API, and it seems no api key is needed, you can fill in the `apiKey` field with `emptyButRequired` or any string instead (Must not be empty).
+3. Copy the API key into the `apiKey` field (see the [Configure](#configure) section).
+4. Use the API key in your workflows to interact with the OpenAI API.
 
 ### Configure
 
@@ -65,7 +66,7 @@ You should obtain this key from the provider you filled in the `baseUrl` field.
 
 If you're using the default value, you can get the key from the [Get API key | Google AI Studio](https://aistudio.google.com/botToken).
 
-If the API provider asked you to make the `apiKey` field empty, it's better to fill the filed with `null` or anything instead due to the OpenAI client module limition.
+If the API provider asked you to make the `apiKey` field empty, you should fill the filed with `emptyButRequired` or any string instead due to the OpenAI client module limition (Must not be empty).
 
 #### `chatModel`