From a3f77c775b8618072d0aa71347df2a8a7643bba9 Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Fri, 22 Dec 2023 15:59:02 +0900 Subject: [PATCH] docs: improve troubleshooting docs --- docs/docs/guides/02-installation/03-linux.md | 2 +- .../01-stuck-on-broken-build.md | 53 ---------- .../01-stuck-on-broken-build.mdx | 96 +++++++++++++++++++ 3 files changed, 97 insertions(+), 54 deletions(-) delete mode 100644 docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.md create mode 100644 docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx diff --git a/docs/docs/guides/02-installation/03-linux.md b/docs/docs/guides/02-installation/03-linux.md index b4b3d0960..7f0db2b78 100644 --- a/docs/docs/guides/02-installation/03-linux.md +++ b/docs/docs/guides/02-installation/03-linux.md @@ -42,7 +42,7 @@ jan-linux-amd64-{version}.deb ## Uninstall Jan -To uninstall VS Code on Linux, you should use your package manager's uninstall or remove option. For Debian/Ubuntu-based distributions, if you installed Jan via the `.deb` package, you can uninstall Jan using the following command: +To uninstall Jan on Linux, you should use your package manager's uninstall or remove option. For Debian/Ubuntu-based distributions, if you installed Jan via the `.deb` package, you can uninstall Jan using the following command: ```bash sudo apt-get remove jan diff --git a/docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.md b/docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.md deleted file mode 100644 index 51d6c848a..000000000 --- a/docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Stuck on a Broken Build -slug: /troubleshooting/stuck-on-broken-build -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: - [ - Jan AI, - Jan, - ChatGPT alternative, - local AI, - private AI, - conversational AI, - no-subscription fee, - large language model, - troubleshooting, - ] ---- - -The following steps will help you troubleshoot and resolve issues related to broken builds. - -1. Delete the application data - -```bash -# Newer versions -rm -rf /Users/$(whoami)/Library/Application\ Support/jan - -# Versions 0.2.0 and older -rm -rf /Users/$(whoami)/Library/Application\ Support/jan-electron -``` - -2. Clear application cache - -```bash -rm -rf /Users/$(whoami)/Library/Caches/jan* -``` - -3. Remove user data - -```bash -rm -rf ./jan -``` - -4. Delete Jan from your `/Applications` folder - -5. If you are using version before `0.4.2` you need to run the following commands - -```bash -ps aux | grep nitro -# Looks for processes like `nitro` and `nitro_arm_64`, and kill them one by one by process ID -kill -9 -``` - -6. Download the latest version from via our homepage, [https://jan.ai/](https://jan.ai/). diff --git a/docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx b/docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx new file mode 100644 index 000000000..ba04abb9e --- /dev/null +++ b/docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx @@ -0,0 +1,96 @@ +--- +title: Stuck on a Broken Build +slug: /troubleshooting/stuck-on-broken-build +description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + troubleshooting, + ] +--- + +{/* Imports */} +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +The following steps will help you troubleshoot and resolve issues related to broken builds. + +1. Unistall Jan + + + + + Delete Jan from your `/Applications` folder + + + + + To uninstall Jan in Windows, use the [Windows Control Panel](https://support.microsoft.com/en-us/windows/uninstall-or-remove-apps-and-programs-in-windows-4b55f974-2cc6-2d2b-d092-5905080eaf98). + + + + + To uninstall Jan on Linux, you should use your package manager's uninstall or remove option. For Debian/Ubuntu-based distributions, if you installed Jan via the `.deb` package, you can uninstall Jan using the following command: + ```bash + sudo apt-get remove jan + ``` + + + + +2. Delete the application data, cache, and user data folders + + + + + ```bash + # Step 1: Delete the application data + ## Newer versions + rm -rf /Users/$(whoami)/Library/Application\ Support/jan + ## Versions 0.2.0 and older + rm -rf /Users/$(whoami)/Library/Application\ Support/jan-electron + + # Step 2: Clear application cache + rm -rf /Users/$(whoami)/Library/Caches/jan* + + # Step 3: Remove all user data + rm -rf ./jan + ``` + + + + + ```bash + # You can delete the `/Jan` directory in Windows's AppData Directory by visiting the following path `%APPDATA%\Jan` + cd C:\Users\%USERNAME%\AppData\Roaming + rm -rf ./Jan + ``` + + + + + ```bash + # You can delete the user data folders located at the following `$HOME/.config/jan` and `~/.jan` + rm -r $HOME/.config/jan + rm -r ~/.jan + ``` + + + + +3. If you are using version before `0.4.2` you need to run the following commands + +```bash +ps aux | grep nitro +# Looks for processes like `nitro` and `nitro_arm_64`, and kill them one by one by process ID +kill -9 +``` + +3. Download the latest version from via our homepage, [https://jan.ai/](https://jan.ai/).