docs: improve troubleshooting docs

DIRAKHIL · Dec 22, 2023 · a3f77c7 · a3f77c7
1 parent 41aee6a
commit a3f77c7
Show file tree

Hide file tree

Showing 3 changed files with 97 additions and 54 deletions.
diff --git 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
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
@@ -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
+
+<Tabs groupId="operating-systems">
+  <TabItem value="mac" label="macOS">
+
+    Delete Jan from your `/Applications` folder
+
+  </TabItem>
+  <TabItem value="win" label="Windows">
+
+    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).
+
+  </TabItem>
+  <TabItem value="linux" label="Linux">
+
+    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
+    ```
+
+  </TabItem>
+</Tabs>
+
+2. Delete the application data, cache, and user data folders
+
+<Tabs groupId="operating-systems">
+  <TabItem value="mac" label="macOS">
+
+    ```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
+    ```
+
+  </TabItem>
+  <TabItem value="win" label="Windows">
+
+    ```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
+    ```
+
+  </TabItem>
+  <TabItem value="linux" label="Linux">
+
+    ```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
+    ```
+
+  </TabItem>
+</Tabs>
+
+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 <PID>
+```
+
+3. Download the latest version from via our homepage, [https://jan.ai/](https://jan.ai/).