From f101419af392b1565299c5ed4e16a9a6a794d80f Mon Sep 17 00:00:00 2001
From: Fuegovic <32828263+fuegovic@users.noreply.github.com>
Date: Wed, 9 Aug 2023 13:38:17 -0400
Subject: [PATCH] docs: general update (#781)

* Update windows_install.md

* Update linux_install.md

* Update mac_install.md

* Update docker_install.md

* Update linux_install.md

* Update windows_install.md

* Update README.md

* Update breaking_changes.md

* Update breaking_changes.md
---
 README.md                             |  1 -
 docs/general_info/breaking_changes.md | 17 +++++++++++++++++
 docs/install/docker_install.md        |  5 +----
 docs/install/linux_install.md         |  2 +-
 docs/install/mac_install.md           |  5 ++---
 docs/install/windows_install.md       | 22 ++++++++++------------
 6 files changed, 31 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 54d2be50f..7ae144ac8 100644
--- a/README.md
+++ b/README.md
@@ -48,7 +48,6 @@ Click on the thumbnail to open the video☝️
 ---
 
 ## ⚠️ [Breaking Changes](docs/general_info/breaking_changes.md) ⚠️
-**Applies to [v0.5.4](docs/general_info/breaking_changes.md#v054) & [v0.5.5](docs/general_info/breaking_changes.md#v055)**
 
 **Please read this before updating from a previous version**
 
diff --git a/docs/general_info/breaking_changes.md b/docs/general_info/breaking_changes.md
index d1fcdbed4..c76eab171 100644
--- a/docs/general_info/breaking_changes.md
+++ b/docs/general_info/breaking_changes.md
@@ -1,5 +1,22 @@
 # ⚠️ **Breaking Changes** ⚠️
 
+## v0.5.8
+**If you have issues after updating, please try to clear your browser cache and cookies!**
+
+Some of the latest changes affect the cookies and can cause weird behaviors if not properly cleared.
+
+## v0.5.7
+
+Now, we have an easier and safer way to update LibreChat. You can simply run `npm run update` from the project directory for a clean update.
+If you want to skip the prompt you can use
+
+for a docker install:
+- `npm run update:docker`
+
+for a local install:
+- `npm run update:local`
+
+
 ## v0.5.5
 Some users have reported an error after updating their docker containers.
 
diff --git a/docs/install/docker_install.md b/docs/install/docker_install.md
index dc323e6f9..707e4f5f0 100644
--- a/docs/install/docker_install.md
+++ b/docs/install/docker_install.md
@@ -37,10 +37,7 @@ Once you have completed all the setup, you can start the LibreChat application b
 That's it! If you need more detailed information on configuring your compose file, see my notes below.
 
 ## Updating LibreChat
-To update LibreChat. enter these commands one after the other from the root dir:
-- git pull
-- docker-compose build
-- docker-compose up
+- Run `npm run update` from the project directory for a clean installation.
 
 ## Advanced Settings
 
diff --git a/docs/install/linux_install.md b/docs/install/linux_install.md
index e9fe138e6..3b19b689c 100644
--- a/docs/install/linux_install.md
+++ b/docs/install/linux_install.md
@@ -128,7 +128,7 @@ gnome-terminal --tab --title="LibreChat" --working-directory=/home/user/LibreCha
 
 ## Update the app version
 
-If you update the LibreChat project files, manually redo the npm ci and npm run frontend steps.
+- Run `npm run update` from the project directory for a clean installation.
 
 ---
 
diff --git a/docs/install/mac_install.md b/docs/install/mac_install.md
index 082167009..d3a48eb57 100644
--- a/docs/install/mac_install.md
+++ b/docs/install/mac_install.md
@@ -87,9 +87,8 @@ npm run backend
 
 
 ## **Update**
-- run `git pull` from the root dir
-- Run npm ci from root directory `npm ci`
-- Build the client by running `npm run frontend`
+
+- Run `npm run update` from the project directory for a clean installation.
 
 ---
 
diff --git a/docs/install/windows_install.md b/docs/install/windows_install.md
index 251195f5b..de07f47cc 100644
--- a/docs/install/windows_install.md
+++ b/docs/install/windows_install.md
@@ -9,14 +9,15 @@ Click on the thumbnail to open the video☝️
 In this video we're going to install LibreChat on Windows 11 using Docker and Git.
 
 #### Timestamps
-0:00 - Intro
-0:10 - Requirements
-0:31 - Docker Installation
-1:50 - Git Installation
-2:27 - LibreChat Installation
-3:07 - Start LibreChat
-3:59 - Access to LibreChat
-4:23 - Outro
+
+- 0:00 - Intro
+- 0:10 - Requirements
+- 0:31 - Docker Installation
+- 1:50 - Git Installation
+- 2:27 - LibreChat Installation
+- 3:07 - Start LibreChat
+- 3:59 - Access to LibreChat
+- 4:23 - Outro
 
 #### Instructions
 - To install LibreChat, you need Docker desktop and Git. Download them from these links:
@@ -103,11 +104,8 @@ Have fun!
 ---
 
 ## **Update**
-To update LibreChat:
-- run `git pull` from the root dir
-- Run npm ci from root directory `npm ci`
-- Build the client by running `npm run frontend`
 
+- Run `npm run update` from the project directory for a clean installation.
 
 ---