diff --git a/docs/docs/guides/img/chat.PNG b/docs/docs/guides/img/chat.PNG new file mode 100644 index 000000000..8cfb47d25 Binary files /dev/null and b/docs/docs/guides/img/chat.PNG differ diff --git a/docs/docs/guides/img/downloading.png b/docs/docs/guides/img/downloading.png new file mode 100644 index 000000000..19ccb1f91 Binary files /dev/null and b/docs/docs/guides/img/downloading.png differ diff --git a/docs/docs/guides/img/explore-model.png b/docs/docs/guides/img/explore-model.png new file mode 100644 index 000000000..841e7792f Binary files /dev/null and b/docs/docs/guides/img/explore-model.png differ diff --git a/docs/docs/guides/img/jan download.PNG b/docs/docs/guides/img/jan-download.PNG similarity index 100% rename from docs/docs/guides/img/jan download.PNG rename to docs/docs/guides/img/jan-download.PNG diff --git a/docs/docs/guides/img/model-catelog.PNG b/docs/docs/guides/img/model-catelog.PNG new file mode 100644 index 000000000..e8a2e1c2e Binary files /dev/null and b/docs/docs/guides/img/model-catelog.PNG differ diff --git a/docs/docs/guides/img/model-version.png b/docs/docs/guides/img/model-version.png new file mode 100644 index 000000000..cf7fe6324 Binary files /dev/null and b/docs/docs/guides/img/model-version.png differ diff --git a/docs/docs/guides/img/set-up.png b/docs/docs/guides/img/set-up.png new file mode 100644 index 000000000..8e0d5f2f5 Binary files /dev/null and b/docs/docs/guides/img/set-up.png differ diff --git a/docs/docs/guides/img/start-model.png b/docs/docs/guides/img/start-model.png new file mode 100644 index 000000000..6a8427ea5 Binary files /dev/null and b/docs/docs/guides/img/start-model.png differ diff --git a/docs/docs/guides/img/window-defender.png b/docs/docs/guides/img/window-defender.png new file mode 100644 index 000000000..7f9dd4b6a Binary files /dev/null and b/docs/docs/guides/img/window-defender.png differ diff --git a/docs/docs/guides/linux.md b/docs/docs/guides/linux.md index a43b6eecb..ba26bf6f4 100644 --- a/docs/docs/guides/linux.md +++ b/docs/docs/guides/linux.md @@ -1,3 +1,47 @@ --- title: Installing Jan on Linux ---- \ No newline at end of file +--- + +# Linux users +## Step 1: Download the Installer +To begin using 👋Jan.ai on your Windows computer, follow these steps: + +1. Visit [Jan.ai](https://jan.ai/). +2. Click on the "Download for Windows" button to download the Jan Installer. + +![Jan Installer](img/jan-download.png) + +## Step 2: Download your first model +Now, let's get your first model: + +1. After installation, you'll find the 👋Jan application icon on your desktop. Double-click to open it. + +2. Welcome to the Jan homepage. Click on "Explore Models" to see the Model catalog. + +![Explore models](img/explore-model.png) + +3. You can also see different quantized versions by clicking on "Show available Versions". + +![Model versions](img/model-version.png) + +- Note: Choose a model that matches your computer's memory and RAM. + +4. Select your preferred model and click "Download." + +![Downloading](img/downloading.PNG) + +## Step 3: Start the model +Once your model is downloaded. Go to "My Models," and then click "Start Model". + +![Start model](img/start-model.PNG) + +## Step 4: Start the conversations +Now you're ready to start using 👋Jan.ai for conversations: + +Click "Chat" and begin your first conversation by selecting "New conversation". + +You can also check the CPU and Memory usage of the computer. + +![Chat](img/chat.PNG) + +That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai. \ No newline at end of file diff --git a/docs/docs/guides/mac.md b/docs/docs/guides/mac.md index 315c3bf68..e5a335ba0 100644 --- a/docs/docs/guides/mac.md +++ b/docs/docs/guides/mac.md @@ -1,3 +1,47 @@ --- title: Installing Jan on Mac ---- \ No newline at end of file +--- + +# Mac users +## Step 1: Download the Installer +To begin using 👋Jan.ai on your Windows computer, follow these steps: + +1. Visit [Jan.ai](https://jan.ai/). +2. Click on the "Download for Windows" button to download the Jan Installer. + +![Jan Installer](img/jan-download.png) + +## Step 2: Download your first model +Now, let's get your first model: + +1. After installation, you'll find the 👋Jan application icon on your desktop. Double-click to open it. + +2. Welcome to the Jan homepage. Click on "Explore Models" to see the Model catalog. + +![Explore models](img/explore-model.png) + +3. You can also see different quantized versions by clicking on "Show available Versions". + +![Model versions](img/model-version.png) + +- Note: Choose a model that matches your computer's memory and RAM. + +4. Select your preferred model and click "Download." + +![Downloading](img/downloading.PNG) + +## Step 3: Start the model +Once your model is downloaded. Go to "My Models," and then click "Start Model". + +![Start model](img/start-model.PNG) + +## Step 4: Start the conversations +Now you're ready to start using 👋Jan.ai for conversations: + +Click "Chat" and begin your first conversation by selecting "New conversation". + +You can also check the CPU and Memory usage of the computer. + +![Chat](img/chat.PNG) + +That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai. \ No newline at end of file diff --git a/docs/docs/guides/troubleshooting.md b/docs/docs/guides/troubleshooting.md index 9662ac078..4d845b488 100644 --- a/docs/docs/guides/troubleshooting.md +++ b/docs/docs/guides/troubleshooting.md @@ -1,3 +1,33 @@ --- title: Troubleshooting --- + +# Jan.ai Troubleshooting Guide +Please note that 👋Jan is in "development mode," and you might encounter issues. If you need to reset your installation, follow these steps: + +## Issue 1: Broken Build +1. Delete the Jan Application from your computer. + +2. Clear the cache by running one of the following commands: + + ```sh + rm -rf /Users/$(whoami)/Library/Application\ Support/jan-electron + ``` + + or + + ```sh + rm -rf /Users/$(whoami)/Library/Application\ Support/jan + ``` + +3. If the above steps fail, use the following commands to find and kill any problematic processes: + + ```sh + ps aux | grep nitro + ``` + + Look for processes like "nitro" and "nitro_arm_64," and kill them one by one with: + + ```sh + kill -9 + ``` \ No newline at end of file diff --git a/docs/docs/guides/windows.md b/docs/docs/guides/windows.md index 441f605da..c7eb6b1a0 100644 --- a/docs/docs/guides/windows.md +++ b/docs/docs/guides/windows.md @@ -4,57 +4,56 @@ title: Installing Jan on Windows # Windows users ## Step 1: Download the Installer -Download the Jan Installer from [Jan.ai](https://jan.ai/) +To begin using 👋Jan.ai on your Windows computer, follow these steps: -Here, you should choose the `Download for Windows` -![Jan Installer](img/jan-download.PNG) +1. Visit [Jan.ai](https://jan.ai/). +2. Click on the "Download for Windows" button to download the Jan Installer. + +![Jan Installer](img/jan-download.png) ## Step 2: Proceed the Windows Defender -You would come by the warning of Windows +When you run the Jan Installer, Windows Defender may display a warning. Here's what to do: - +1. Click "Run away" to accept and install 👋Jan.ai. -Choose `Run away` to accept `Jan.ai`. +![Accept Jan](img/window-defender.png) -Wait till the `Jan` finish installation - +2. Wait for the 👋Jan.ai installation to complete. +![Setting up](img/set-up.png) ## Step 3: Download your first model -Click on `Jan` on your desktop to open. +Now, let's get your first model: -Welcome to `Jan` home page. -Choose `Explore Models` - +1. After installation, you'll find the 👋Jan application icon on your desktop. Double-click to open it. -You will be bring to the Model catalog. +2. Welcome to the Jan homepage. Click on "Explore Models" to see the Model catalog. -You can always choose other models and other model versions by click on `Show available Versions` +![Explore models](img/explore-model.png) +3. You can also see different quantized versions by clicking on "Show available Versions". - +![Model versions](img/model-version.png) -- Note: Please choose the model suit your memory and RAM. +- Note: Choose a model that matches your computer's memory and RAM. -Choose the model with your favor and hit `Download`. +4. Select your preferred model and click "Download." - +![Downloading](img/downloading.PNG) ## Step 4: Start the model +Once your model is downloaded. Go to "My Models," and then click "Start Model". + +![Start model](img/start-model.PNG) ## Step 5: Start the conversations +Now you're ready to start using 👋Jan.ai for conversations: -That's it. Have fun with LLMs. +Click "Chat" and begin your first conversation by selecting "New conversation". -> #### Note: -> As Jan is `development mode`, you might get stuck on a broken build. -> -> ##### To reset your installation: -> 1. Delete Jan Application from /Applications -> -> 2. Clear cache: `rm -rf /Users/$(whoami)/Library/Application\ Support/jan-electron` -> OR `rm -rf /Users/$(whoami)/Library/Application\ Support/jan` -> -> 3. If the above fail please use: -> `ps aux | grep nitro // There is nitro and nitro_arm_64 or something kill -9 // kill it 1-by-1 and see if Jan still works` +You can also check the CPU and Memory usage of the computer. + +![Chat](img/chat.PNG) + +That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai. \ No newline at end of file