From 7734823da379be062a7c1c06835126e76c26d4aa Mon Sep 17 00:00:00 2001 From: sr-remsha <46220620+sr-remsha@users.noreply.github.com> Date: Tue, 18 Jun 2024 14:57:17 +0200 Subject: [PATCH] chore: update README.md (#37) --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 34cc1113..7cce901c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Overview -A theme is a suite of static resources of images, fonts and color palettes you can use to customize the look and feel of your chat application. The AI DIAL Chat Themes project is an HTTP server hosting themes for the AI DIAL Chat web application. By having a dedicated server for themes, it enables developers and designers to work concurrently and implement changes to themes without needing to redeploy the AI DIAL Chat application. +A theme is a collection of static resources including images, fonts, and color palettes that you can utilize to personalize the appearance of your [AI DIAL Chat](https://github.com/epam/ai-dial-chat) application. These resources can be stored anywhere and accessed by the chat application via the internet. We provide the AI DIAL Chat Themes service as a convenient method for hosting these static resources and making them accessible for the chat application. However, you have the flexibility to choose your own method for accomplishing this. -> Refer to [AI DIAL Chat](https://github.com/epam/ai-dial-chat) to learn more about it. +This approach, having static resources externally, enables developers and designers to work concurrently and implement changes to themes without needing to redeploy the AI DIAL Chat application. -When a theme is configured, chat application users can select it in [user settings](https://github.com/epam/ai-dial/blob/main/docs/user-guide.md#user-settings). +Chat application users can then select themes in [user settings](https://github.com/epam/ai-dial/blob/main/docs/user-guide.md#user-settings). # Set Up Developer Environment @@ -28,15 +28,15 @@ make run # Helm Deployment and Configuration -1. You can deploy AI DIAL Chat Themes as a part of a [common dial Helm chart](https://github.com/epam/ai-dial-helm/tree/main/charts/dial) or in a [stand-alone chart](https://github.com/epam/ai-dial-helm/tree/main/charts/dial-extension). +1. You can deploy AI DIAL Chat Themes service using a common [dial](https://github.com/epam/ai-dial-helm/tree/main/charts/dial) Helm chart or using a stand-alone chart [dial-extension](https://github.com/epam/ai-dial-helm/tree/main/charts/dial-extension). > Refer to [AI DIAL Helm](https://github.com/epam/ai-dial-helm) to learn about the deployment options and view the examples of charts. -2. Further, it is necessary to configure AI DIAL Chat to work with AI DIAL Chat Themes. To do that, add `THEMES_CONFIG_HOST` to the chat configuration - refer to [documentation](https://github.com/epam/ai-dial-chat/blob/development/apps/chat/README.md) for details. `THEMES_CONFIG_HOST` environment variable contains the URL to your nginx server with the configuration and images. This ensures that the application fetches your configuration file during loading. If the environment variable is not provided, [default themes and model icons]((./static/config.json)) will be applied. +2. In the [config.json](./static/config.json) file, you can define and configure custom themes or use (edit) default ones. Images can be stored in the **static** folder as well. However, you can store images anywhere and provide URLs in the config file. -3. In the [config.json](./static/config.json) file, you can define and configure custom themes or use (edit) default ones. All the configured themes are available in the chat application in [user settings](https://github.com/epam/ai-dial/blob/main/docs/user-guide.md#user-settings). +3. Further, it is necessary to configure AI DIAL Chat to access the static resources and the themes configuration. To do that, add `THEMES_CONFIG_HOST` to the chat configuration - refer to [documentation](https://github.com/epam/ai-dial-chat/blob/development/apps/chat/README.md) for details. `THEMES_CONFIG_HOST` environment variable contains the URL to your nginx server with the configuration and images (this is the case when you use AI DIAL Chat Themes to provide static resoures for the chat application). This ensures that the application fetches your configuration file during loading. If the environment variable is not provided, [default themes and model icons]((./static/config.json)) will be applied. -4. After applying changes, it is necessary to redeploy the themes server. Changes will take effect automatically on the chat UI after 24hrs or upon the page reload. +4. After applying changes, it is necessary to redeploy the themes server. Changes will take effect automatically on the chat UI after 24hrs or upon the page reload. All the configured themes will be available in the chat application in [user settings](https://github.com/epam/ai-dial/blob/main/docs/user-guide.md#user-settings). # Working with Themes @@ -69,7 +69,7 @@ The URL for `app-logo` will be recognized as a relative URL and transformed into ## Customize Image URLs -You can customize image URLs using a configuration file [config.json](./static/config.json). To achieve this, create the following structure: +You can provide image URLs in the configuration file [config.json](./static/config.json). To achieve this, create the following structure: ```json {