GITBOOK-68: No subject

docs/SUMMARY.md

@@ -25,9 +25,11 @@
 * [NLP Training](user-guide/nlp-training.md)
 * [Configure Content](user-guide/configure-content/README.md)
   * [Content Types](user-guide/configure-content/content-types.md)
-  * [Translations](user-guide/configure-content/translations.md)
   * [Manage Persistent Menu](user-guide/configure-content/manage-persistent-menu.md)
   * [Media Library](user-guide/configure-content/media-library.md)
+* [Localization](user-guide/localization/README.md)
+  * [Languages](user-guide/localization/languages.md)
+  * [Translations](user-guide/localization/translations.md)
 * [Users and Roles](user-guide/users-and-roles/README.md)
   * [Manage users](user-guide/users-and-roles/manage-users.md)
   * [Manage roles](user-guide/users-and-roles/manage-roles.md)

docs/introduction/features.md

@@ -87,7 +87,7 @@ When your chatbot encounters a complex or sensitive issue, Hexabot's Agent Takeo
 
 ## User and Role Management
 
-<figure><img src="../.gitbook/assets/image.png" alt=""><figcaption><p>Manage Users</p></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (20).png" alt=""><figcaption><p>Manage Users</p></figcaption></figure>
 
 Hexabot offers robust user management features that streamline collaboration and enhance security within your chatbot projects. You can effortlessly invite new users to join your workspace, making it easy to bring team members, stakeholders, or clients on board. Invitations are sent directly through the platform, allowing for a smooth onboarding process and immediate engagement with your project.
 

docs/quickstart/installation.md

@@ -32,11 +32,20 @@ Check NVM official documentation for more details :[https://github.com/nvm-sh/nv
 $ git clone https://github.com/hexastack/hexabot.git
 ```
 
-2. **Environment Setup:** \
-   To configure the environment variables, use the Makefile at the root folder for initialization:
+2. **Installation:**
+
+Install node dependencies using:
 
 ```
-$ make init
+$ npm install
+```
+
+2. **Environment Setup:** 
+
+To configure the environment variables, use the Makefile at the root folder for initialization:
+
+```
+$ npx hexabot init
 ```
 
 This will copy the `.env.example` file to `.env` in the `./docker` directory if the file does not already exist.
@@ -66,13 +75,19 @@ This will install `make` and other developer tools without needing to install th
 </details>
 
 ```
-$ make start
+$ npx hexabot start
 ```
 
 Or for development mode:
 
 ```
-$ make dev
+$ npx hexabot dev
+```
+
+You can enable specific services like the NLU engine, nginx or smtp4dev (coma seperated) :
+
+```
+$ npx hexabot dev --enable=nlu
 ```
 
 ### Usage
@@ -95,9 +110,8 @@ Live Chat Widget demo is accessible via [http://localhost:5173](http://localhost
 
 ### Useful Commands
 
-* `make init` : Copies the .env.example file to .env in the ./docker directory if .env does not exist. This is usually used for initial setup.
-* `make dev` : Builds the Docker images locally before starting the services in development mode. It first checks the .env file for completeness against .env.example.
-* `make start` : Starts the app by pulling the Docker images from Docker Hub. This target also checks the .env file for required variables.
-* `make stop` : Stops all running Docker services defined in the compose files.
-* `make destroy` : Stops all services and removes all volumes associated with the Docker compose setup, ensuring a clean state.
-* `make check-env` : Checks if the ./docker/.env file exists and contains all the necessary environment variables as defined in ./docker/.env.example. If the file does not exist, it is created from the example. It also lists missing variables if any.
+* `npx hexabot init` : Copies the .env.example file to .env in the ./docker directory if .env does not exist. This is usually used for initial setup.
+* `npx hexabot dev` : Builds the Docker images locally before starting the services in development mode. It first checks the .env file for completeness against .env.example.
+* `npx hexabot start` : Starts the app by pulling the Docker images from Docker Hub. This target also checks the .env file for required variables.
+* `npx hexabot stop` : Stops all running Docker services defined in the compose files.
+* `npx hexabot destroy` : Stops all services and removes all volumes associated with the Docker compose setup, ensuring a clean state.

docs/user-guide/context-variables.md

@@ -1,32 +1,51 @@
 # Context Variables
 
-<figure><img src="../.gitbook/assets/image (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (21).png" alt=""><figcaption><p>Manage Context Variables</p></figcaption></figure>
 
 Context variables are powerful tools in Hexabot that allow you to store and manage information gathered during a conversation with a user. This information can then be used to personalize the chatbot's responses, make decisions within the conversation flow, or trigger specific actions.
 
-Think of context variables as temporary storage containers that hold data specific to a particular conversation. For example, you could store the user's name, their preferred language, or their order details.
+Think of context variables as storage containers that hold data specific to a particular conversation. For example, you could store the user's name, their preferred language, or their order details.
 
-**1. Access Context Variables page:**
+### 1. Types of Context Variables
 
-* Navigate to the "Context Vars" or "Context Variables" section. This is typically found in the main menu.
+In Hexabot, context variables can be either **Permanent** or **Non-Permanent**, depending on whether you want the data to persist beyond the current conversation.
 
-**2. Creating a New Context Variable:**
+#### 1. Non-Permanent Context Variables
+
+* **Temporary Storage**: Non-permanent context variables are stored in the conversation context.
+* **Scope**: They are specific to the ongoing conversation and are lost once the conversation ends.
+* **Use Case**: Ideal for storing temporary data that is relevant only during the current interaction.
+* **Example**: If a bot asks a user for their current location during a session, the bot may store the response as a non-permanent context variable to use in the rest of the conversation.
+
+#### 2. Permanent Context Variables
+
+* **Persistent Storage**: Permanent context variables are stored in the subscriber context, which means they persist across multiple conversations.
+* **Scope**: These variables retain their values even after a conversation has ended, allowing the bot to remember information about a user across different interactions.
+* **Use Case**: Ideal for storing user preferences or information that should be remembered for future interactions.
+* **Example**: If a user provides their preferred language or opts into notifications, the bot can store this preference permanently. The bot will retain this information for future use, without needing to ask the user again in subsequent conversations.
+
+### **2. Access Context Variables page**
+
+Navigate to the "Context Vars" or "Context Variables" section. This is typically found in the main menu.
+
+### **3. Creating a New Context Variable**
 
 * **Click "Add Context Variable" or a similar button:** This will open a form where you can define a new context variable.
-* **Provide Variable label:** Choose a descriptive label for your variable, reflecting the type of information it will store. For example:
-  * user\_name
-  * preferred\_language
-  * order\_id
-  * location
+* **Provide Variable label:** Choose a descriptive label for your variable, reflecting the type of information you would like to collect. For example:
+  * Phone Number
+  * Email
+* **Set the "Permanent" Option**:
+  * **Permanent**: Check this option if you want the variable to be stored permanently and persist across conversations.
+  * **Non-Permanent**: Leave this option unchecked if you want the variable to be temporary and only last for the duration of the current conversation.
 * **Save Changes:** Click the "Submit" button to create your new context variable.
 
-**3. Managing Existing Context Variables:**
+### **4. Managing Existing Context Variables**
 
 * **View Existing Variables:** In the "Context Vars" section, you can view a list of the context variables you've created.
 * **Edit Variable label:** You can edit a variable's label. However, you cannot change it name once it's created.
 * **Delete a Variable:** If a context variable is no longer needed, you can delete it from the list. Be careful because deleting a variable will remove all data stored within it.
 
-**3. Using Context Variables:**
+### **5. Using Context Variables**
 
 Once a context variable is defined, you can edit a given block's options and add that context variable to capture the user input message. In the following example, we will collect the phone number entered by the user.
 
@@ -36,8 +55,6 @@ Once the block gets triggered, the value will be stored within the context varia
 
 <figure><img src="../.gitbook/assets/image (19).png" alt=""><figcaption><p>Using Context Variables</p></figcaption></figure>
 
-
-
 {% hint style="info" %}
 **Additional Notes**
 

docs/user-guide/localization/README.md

@@ -0,0 +1,11 @@
+# Localization
+
+Hexabot's chatbot builder allows you to create multilingual chatbots by managing languages within the platform. This feature enables you to define the languages your chatbot will support and handle translations for blocks, messages, quick replies, buttons, and more.
+
+### Key Features
+
+* **Add, update, and delete languages**: You can easily manage the languages your chatbot supports.
+* **Multilingual conversations**: The chatbot will automatically use the language of the end-user (subscriber).
+* **Translation capabilities**: Each language defined in the system allows you to translate blocks, messages, quick replies, buttons, etc.
+* **Default language**: You can set a default language for your chatbot. This will be the fallback language if no specific language is detected or set for the end-user.
+* **RTL support**: For languages that are written from right to left (RTL), such as Arabic or Hebrew, you can specify whether a language is RTL or not.

docs/user-guide/localization/languages.md

@@ -0,0 +1,51 @@
+---
+icon: globe
+---
+
+# Languages
+
+Once you have added multiple languages, your chatbot will dynamically respond to users based on their language preference. If the end-user’s language is detected, the chatbot will automatically switch to that language. Otherwise, the default language will be used.
+
+<figure><img src="../../.gitbook/assets/image.png" alt=""><figcaption><p>Manage Languages</p></figcaption></figure>
+
+### Adding a Language
+
+To add a language to your chatbot, follow these steps:
+
+1. Navigate to the **Languages** section of the chatbot builder.
+2. Click on the **Add Language** button.
+3. In the dialog, enter the following information:
+   * **Title**: The name of the language (e.g., English, French, Arabic).
+   * **Code**: The language code (e.g., `en` for English, `fr` for French, `ar` for Arabic). It is recommended to use the ISO 639-1 code for each language.
+   * **RTL**: Toggle whether the language is a right-to-left language.
+4. Click **Save** to add the language.
+
+### Updating a Language
+
+To update a language:
+
+1. Navigate to the **Languages** section.
+2. Select the language you want to update.
+3. Modify the **Title**, **Code**, or **RTL** setting as needed.
+4. Click **Save** to apply your changes.
+
+### Deleting a Language
+
+To delete a language:
+
+1. Navigate to the **Languages** section.
+2. Click on the delete icon next to the language you wish to remove.
+3. Confirm the deletion.
+
+> **Note**: Deleting a language will remove its translations from the chatbot. All NLU samples will be set to the default language which cannot be deleted. You need always to have at least one language.
+
+### Default Language
+
+The default language serves as the primary language for your chatbot. To set a default language:
+
+1. Navigate to the **Languages** section.
+2. Click the checkbox next to the language you want to set as default.
+3. Click **Save**.
+
+The default language will be used when the chatbot cannot detect the language of the end-user.
+

docs/user-guide/localization/translations.md

@@ -6,19 +6,16 @@ icon: language
 
 Expanding your audience and reaching global users is essential for chatbot success. Hexabot's built-in translation feature simplifies the process of creating multilingual chatbots, allowing you to offer personalized experiences in multiple languages.
 
-<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcvJadur1pV2UKti8eC2OEY_ZR7UhcDwvSL94OxTI6S6EhvqV_t1QEkCcap-f6Pc4P8TCSi8qMX0tWoiVykGbeXQL3TKaR7E0g__YjHTByVOyDJwKvaxyuSi4r1bMc7Wm7MzTDY9zXxaFagrkLNFHoanhrP?key=c4KGOy1R8duHlV2m8G2iNQ" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../.gitbook/assets/image (23).png" alt=""><figcaption><p>Manage Translations</p></figcaption></figure>
 
-**Step-by-Step Guide to Translating Content in Hexabot:**
+**Step-by-Step Guide to Translating Content:**
 
 1. **Access the Translations Section:**
    * Log in to your Hexabot account.
-   * Go to your chatbot project's settings or the "CMS" (Content Management System) section.
-   * Locate the "Translations" page.
-2. **Choose the Content to Translate:**
-   * Select the specific content entry you want to translate.
-3. **Add Target Languages:**
-   * Choose the language(s) you want to translate your content into. Hexabot have an  "Add Language" button or dropdown menu to select from the available languages.
-4. **Enter Translations:**
+   * Click on the "Localization" section in the sidebar and navigate to "Translations" page.
+2. **Hit the "Refresh" button :** This will scan the database for all the strings that are being used in blocks (text messages, buttons, quick replies, ...). This action will also remove strings that are not present anymore.
+3. **Choose the Content to Translate:** Click on the "Edit" button of a specific content entry you want to translate.
+4. **Translate:**
    * You'll see the original text in the source language, alongside fields for entering the translated text for each target language.
    * Enter the accurate translations for each field in your chosen languages.
 5. **Save Your Translations:**