Merge pull request #4412 from janhq/chore/update-jan-docs

chore: Update Jan Docs (2)
janhq · Jan 7, 2025 · 57b605f · 57b605f
2 parents 56a5ad8 + e082ae2
commit 57b605f
Show file tree

Hide file tree

Showing 31 changed files with 135 additions and 106 deletions.
diff --git a/docs/src/pages/docs/_assets/jan-app.png b/docs/src/pages/docs/_assets/jan-app.png
diff --git a/docs/src/pages/docs/_assets/model-management-04.png b/docs/src/pages/docs/_assets/model-management-04.png
diff --git a/docs/src/pages/docs/_assets/model-management-05.png b/docs/src/pages/docs/_assets/model-management-05.png
diff --git a/docs/src/pages/docs/_assets/model-management-06.png b/docs/src/pages/docs/_assets/model-management-06.png
diff --git a/docs/src/pages/docs/_assets/model-management-07.png b/docs/src/pages/docs/_assets/model-management-07.png
diff --git a/docs/src/pages/docs/_assets/settings-01.png b/docs/src/pages/docs/_assets/settings-01.png
diff --git a/docs/src/pages/docs/_assets/settings-02.png b/docs/src/pages/docs/_assets/settings-02.png
diff --git a/docs/src/pages/docs/_assets/settings-03.png b/docs/src/pages/docs/_assets/settings-03.png
diff --git a/docs/src/pages/docs/_assets/settings-04.png b/docs/src/pages/docs/_assets/settings-04.png
diff --git a/docs/src/pages/docs/_assets/settings-05.png b/docs/src/pages/docs/_assets/settings-05.png
diff --git a/docs/src/pages/docs/_assets/settings-06.png b/docs/src/pages/docs/_assets/settings-06.png
diff --git a/docs/src/pages/docs/_assets/settings-07.png b/docs/src/pages/docs/_assets/settings-07.png
diff --git a/docs/src/pages/docs/_assets/settings-08.png b/docs/src/pages/docs/_assets/settings-08.png
diff --git a/docs/src/pages/docs/_assets/settings-09.png b/docs/src/pages/docs/_assets/settings-09.png
diff --git a/docs/src/pages/docs/_assets/settings-10.png b/docs/src/pages/docs/_assets/settings-10.png
diff --git a/docs/src/pages/docs/_assets/settings-11.png b/docs/src/pages/docs/_assets/settings-11.png
diff --git a/docs/src/pages/docs/_assets/settings-12.png b/docs/src/pages/docs/_assets/settings-12.png
diff --git a/docs/src/pages/docs/_assets/settings-13.png b/docs/src/pages/docs/_assets/settings-13.png
diff --git a/docs/src/pages/docs/_assets/settings-14.png b/docs/src/pages/docs/_assets/settings-14.png
diff --git a/docs/src/pages/docs/_assets/settings-15.png b/docs/src/pages/docs/_assets/settings-15.png
diff --git a/docs/src/pages/docs/_assets/settings-17.png b/docs/src/pages/docs/_assets/settings-17.png
diff --git a/docs/src/pages/docs/_assets/settings-18.png b/docs/src/pages/docs/_assets/settings-18.png
diff --git a/docs/src/pages/docs/_assets/trouble-shooting-01.png b/docs/src/pages/docs/_assets/trouble-shooting-01.png
diff --git a/docs/src/pages/docs/_assets/trouble-shooting-02.png b/docs/src/pages/docs/_assets/trouble-shooting-02.png
diff --git a/docs/src/pages/docs/desktop/linux.mdx b/docs/src/pages/docs/desktop/linux.mdx
@@ -23,6 +23,7 @@ keywords:
 
 import FAQBox from '@/components/FaqBox'
 import { Tabs, Callout, Steps } from 'nextra/components'
+import { Settings } from 'lucide-react'
 
 
 
@@ -68,32 +69,32 @@ Please check whether your Linux distribution supports desktop, server, or both e
 - Excavator processors (Q2 2015) and newer
 
 <Callout type="info">
-Jan requires a processor with AVX2 for best performance. See [full list of supported processors.](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#CPUs_with_AVX2) While older processors with AVX/AVX-512 will work, you may experience slower performance.
+Jan requires a processor with **AVX2 or newer** for optimal performance. See [full list of supported processors](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#CPUs_with_AVX2). While Jan may run on processors with only AVX support, performance will be significantly reduced.
 </Callout>
 </Tabs.Tab>
 
 <Tabs.Tab>
-- 8GB → 3B models (int4)
-- 16GB → 7B models (int4)
-- 32GB → 13B models (int4)
+- 8GB → up to 3B parameter models (int4)
+- 16GB → up to 7B parameter models (int4)
+- 32GB → up to 13B parameter models (int4)
 
 <Callout type="info">
 DDR2 RAM minimum supported, newer generations recommended for better performance.
 </Callout>
 </Tabs.Tab>
 
 <Tabs.Tab>
-- 6GB → 3B model (int4) with `ngl` at 120
-- 8GB → 7B model (int4) with `ngl` at 120
-- 12GB → 13B model (int4) with `ngl` at 120
+- 6GB → up to 3B parameter models (int4) 
+- 8GB → up to 7B parameter models (int4)
+- 12GB → up to 13B parameter models (int4)
 
 <Callout type="info">
 Minimum 6GB VRAM recommended for NVIDIA, AMD, or Intel Arc GPUs.
 </Callout>
 </Tabs.Tab>
 
 <Tabs.Tab>
-At least 10GB for app installation and model downloads.
+At least **10GB** for app installation and model downloads.
 </Tabs.Tab>
 
 </Tabs>
@@ -179,7 +180,7 @@ chmod +x jan-linux-x86_64-{version}.AppImage
 
 By default, Jan is installed in the following directory:
 
-```
+```bash
 # Custom installation directory
 $XDG_CONFIG_HOME = /home/username/custom_config
 
@@ -238,9 +239,9 @@ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/cuda/lib64
 See [detailed instructions](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#post-installation-actions).
 
 ### Step 2: Enable GPU Acceleration
-1. In Jan, navigate to **Settings** > **Hardware** 
-3. Select and enable your prefered NVIDIA GPU(s)
-4. App reload is required after the selection
+1. Navigate to **Settings** (<Settings width={16} height={16} style={{display:"inline"}}/>) > **Advanced Settings** 
+2. At **GPU Acceleration**, toggle on and select your preferred GPU(s)
+3. App reload is required after the selection
 
 
 <Callout type="info">
@@ -252,23 +253,32 @@ While **Vulkan** can enable Nvidia GPU acceleration in the Jan app, **CUDA** is
 </Tabs.Tab>
 
 <Tabs.Tab>
-To enable the use of your AMD GPU in the Jan app, you need to activate the Vulkan support first by following the steps below:
+AMD GPUs require **Vulkan** support.
+
+<Callout type="warning">
+ This feature is currently experimental and must be enabled through [Experimental Mode](/docs/settings#experimental-mode) in **Advanced Settings**.
+</Callout>
+
+1. Navigate to **Settings** (<Settings width={16} height={16} style={{display:"inline"}}/>) > **Advanced Settings** 
+2. Enable **Experimental Mode**
+3. Under **GPU Acceleration**, enable **Vulkan Support**
+4. At **GPU Acceleration**, toggle on and select your preferred GPU(s)
+5. App reload is required after the selection
 
-1. Open Jan application
-2. Go to **Settings** → **Advanced Settings** → enable the **Experimental Mode**
-3. Enable the **Vulkan Support** under the **GPU Acceleration**
-4. Enable the **GPU Acceleration** and choose the AMD GPU you want to use
-5. A success notification saying **Successfully turned on GPU acceleration** will appear when GPU acceleration is activated
 </Tabs.Tab>
 
 <Tabs.Tab>
-To enable the use of your Intel Arc GPU in the Jan app, you need to activate the Vulkan support first by following the steps below:
+Intel Arc GPUs require **Vulkan** support. 
+
+<Callout type="warning">
+ This feature is currently experimental and must be enabled through [Experimental Mode](/docs/settings#experimental-mode) in **Advanced Settings**.
+</Callout>
 
-1. Open Jan application
-2. Go to **Settings** → **Advanced Settings** → enable the **Experimental Mode**
-3. Enable the **Vulkan Support** under the **GPU Acceleration**
-4. Enable the **GPU Acceleration** and choose the Intel Arc GPU you want to use
-5. A success notification saying **Successfully turned on GPU acceleration** will appear when GPU acceleration is activated
+1. Navigate to **Settings** (<Settings width={16} height={16} style={{display:"inline"}}/>) > **Advanced Settings** 
+2. Enable **Experimental Mode**
+3. Under **GPU Acceleration**, enable **Vulkan Support**
+4. At **GPU Acceleration**, toggle on and select your preferred GPU(s)
+5. App reload is required after the selection
 </Tabs.Tab>
 
 </Tabs>

diff --git a/docs/src/pages/docs/desktop/mac.mdx b/docs/src/pages/docs/desktop/mac.mdx
@@ -132,14 +132,7 @@ See [Jan Data Folder](/docs/data-folder) for more details about the data folder
 
 Open **Terminal** and run these commands to remove all Jan-related data:
 ```bash
-# Remove all user data
-rm -rf ~/jan
-
-# Delete application data
 rm -rf ~/Library/Application\ Support/Jan/data
-
-# Delete application cache
-rm -rf ~/Library/Application\ Support/Jan/cache
 ```
 </Steps>
 

diff --git a/docs/src/pages/docs/desktop/windows.mdx b/docs/src/pages/docs/desktop/windows.mdx
@@ -22,6 +22,7 @@ keywords:
 
 import { Tabs, Callout, Steps } from 'nextra/components'
 import FAQBox from '@/components/FaqBox'
+import { Settings } from 'lucide-react'
 
 
 # Windows Installation
@@ -39,23 +40,29 @@ Ensure that your system meets the following requirements to use Jan effectively:
 - Excavator processors (Q2 2015) and newer.
 </Tabs.Tab>
 </Tabs>
+
 <Callout type="info">
-Jan requires a processor with AVX2 for best performance. See [full list of supported processors.](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#CPUs_with_AVX2) While older processors with AVX/AVX-512 will work, you may experience slower performance.
+Jan requires a processor with **AVX2 or newer** for optimal performance. See [full list of supported processors](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#CPUs_with_AVX2). While Jan may run on processors with only AVX support, performance will be significantly reduced.
 </Callout>
+
 - **Memory (RAM)**
-  - 8GB > 3B parameter models (int4)
-  - 16GB > 7B parameter models (int4)
-  - 32GB > 13B parameter models (int4)
+  - 8GB → up to 3B parameter models (int4)
+  - 16GB → up to 7B parameter models (int4)
+  - 32GB → up to 13B parameter models (int4)
+
 <Callout type="info">
 DDR2 RAM is supported but newer RAM generations are recommended for better performance.
 </Callout>
+
 - **GPU**:
-  - 6GB > 3B models with **ngl** at 120 (full speed)
-  - 8GB > 7B models with **ngl** at 120 (full speed)
-  - 12GB > 13B models with **ngl** at 120 (full speed)
+  - 6GB → up to 3B parameter models 
+  - 8GB → up to 7B parameter models 
+  - 12GB → up to 13B parameter models 
+
 <Callout type="info">
 Minimum 6GB VRAM recommended for NVIDIA, AMD, or Intel Arc GPUs.
 </Callout>
+
 - **Storage:** Minimum 10GB free space for application and model downloads
 
 
@@ -153,9 +160,9 @@ Expected output should show your GPU model and driver version.
 nvcc --version
 ```
 ### Step 2: Enable GPU Acceleration
-1. In Jan, navigate to **Settings** > **Hardware** 
-3. Select and enable your prefered NVIDIA GPU(s)
-4. App reload is required after the selection
+1. Navigate to **Settings** (<Settings width={16} height={16} style={{display:"inline"}}/>) > **Advanced Settings** 
+2. At **GPU Acceleration**, toggle on and select your preferred GPU(s)
+3. App reload is required after the selection
 
 <Callout type="info">
 While Jan supports both CUDA and Vulkan for NVIDIA GPUs, we strongly recommend using CUDA for optimal performance.
@@ -166,23 +173,32 @@ While Jan supports both CUDA and Vulkan for NVIDIA GPUs, we strongly recommend u
 </Tabs.Tab>
 
 <Tabs.Tab>
-AMD GPUs require **Vulkan** support, which must be activated through **Experimental Mode**.
-1. Launch Jan
-2. Navigate to **Settings** > **Advanced Settings**
-3. Enable **Experimental Mode**
-4. Under **GPU Acceleration**, enable **Vulkan Support**
-5. Enable **GPU Acceleration** and select your AMD GPU
-6. App reload is required after the selection
+AMD GPUs require **Vulkan** support.
+
+<Callout type="warning">
+ This feature is currently experimental and must be enabled through [Experimental Mode](/docs/settings#experimental-mode) in **Advanced Settings**.
+</Callout>
+
+1. Navigate to **Settings** (<Settings width={16} height={16} style={{display:"inline"}}/>) > **Advanced Settings** 
+2. Enable **Experimental Mode**
+3. Under **GPU Acceleration**, enable **Vulkan Support**
+4. At **GPU Acceleration**, toggle on and select your preferred GPU(s)
+5. App reload is required after the selection
+
 </Tabs.Tab>
 
 <Tabs.Tab>
-Intel Arc GPUs require **Vulkan** support, which must be activated through **Experimental Mode**.
-1. Launch Jan
-2. Navigate to **Settings** > **Advanced Settings**
-3. Enable **Experimental Mode**
-4. Under **GPU Acceleration**, enable **Vulkan Support**
-5. Enable **GPU Acceleration** and select your Intel Arc GPU
-6. App reload is required after the selection
+Intel Arc GPUs require **Vulkan** support. 
+
+<Callout type="warning">
+ This feature is currently experimental and must be enabled through [Experimental Mode](/docs/settings#experimental-mode) in **Advanced Settings**.
+</Callout>
+
+1. Navigate to **Settings** (<Settings width={16} height={16} style={{display:"inline"}}/>) > **Advanced Settings** 
+2. Enable **Experimental Mode**
+3. Under **GPU Acceleration**, enable **Vulkan Support**
+4. At **GPU Acceleration**, toggle on and select your preferred GPU(s)
+5. App reload is required after the selection
 </Tabs.Tab>
 
 </Tabs>
@@ -215,6 +231,11 @@ To ensure a complete uninstallation, remove the app cache:
 1. Navigate to `C:\Users\[username]\AppData\Roaming`
 2. Delete Jan folder
 
+or through **Terminal**:
+```
+cd C:\Users\%USERNAME%\AppData\Roaming
+rmdir /S jan
+```
 </Steps>
 
 <Callout type="warning">

diff --git a/docs/src/pages/docs/index.mdx b/docs/src/pages/docs/index.mdx
@@ -25,7 +25,7 @@ import FAQBox from '@/components/FaqBox'
 ![Jan's Cover Image](./_assets/jan-app.png)
 
 
-Jan is a ChatGPT-alternative that runs 100% offline on your [Desktop](/docs/desktop-installation). Our goal is to make it easy for a layperson[^1] to download and run LLMs and use AI with full control and [privacy](https://www.reuters.com/legal/legalindustry/privacy-paradox-with-ai-2023-10-31/).
+Jan is a ChatGPT-alternative that runs 100% offline on your desktop & mobile (*comming soon*). Our goal is to make it easy for a layperson[^1] to download and run LLMs and use AI with full control and [privacy](https://www.reuters.com/legal/legalindustry/privacy-paradox-with-ai-2023-10-31/).
 
 Jan is powered by [Cortex](https://cortex.so/), our embeddable local AI engine. 
 
@@ -38,10 +38,10 @@ You'll be able to use it with [Continue.dev](https://jan.ai/integrations/coding/
 ### Features
 
 - Download popular open-source LLMs (Llama3, Gemma or Mistral,...) from [Model Hub](./docs/models/manage-models.mdx) or import any GGUF models
-- Connect to [cloud model services](https://jan.ai/docs/remote-inference/openai) (OpenAI, Anthropic, Mistral, Groq,...)
+- Connect to [cloud model services](/docs/remote-models/openai) (OpenAI, Anthropic, Mistral, Groq,...)
 - [Chat](./docs/threads.mdx) with AI models & [customize their parameters](./docs/models/model-parameters.mdx) in an intuitive interface
 - Use [local API server](https://jan.ai/api-reference) with OpenAI-equivalent API
-- Customize Jan with [extensions](https://jan.ai/docs/extensions)
+- Customize Jan with [extensions](/docs/extensions)
 
 ### Philosophy
 
@@ -50,7 +50,7 @@ Jan is built to be [user-owned](about#-user-owned):
 - [Local-first](https://www.inkandswitch.com/local-first/), with all data stored locally
 - Runs 100% offline, with privacy by default
 - Free choice of AI models, both local and cloud-based
-- We do not [collect or sell user data](/privacy)
+- We do not collect or sell user data. See our [Privacy](/privacy).
 
 <Callout>
   You can read more about our [philosophy](/about#philosophy) here. 
@@ -77,25 +77,27 @@ Jan is built on the shoulders of many upstream open-source projects:
 </FAQBox>
 
 <FAQBox title="How do I use Jan?">
-  Download Jan Desktop on your computer, download a compatible LLM, connect to a remote AI with the API key, and start chatting. You can switch between models as needed.
+  Download Jan on your computer, download a compatible model or connect to a cloud AI, and start chatting. See details in our [Quick Start](/docs/quickstart) guide.
 </FAQBox>
 
 <FAQBox title="Is Jan compatible with my operating system?">
-  Jan is available for Mac, Windows, and Linux, ensuring wide compatibility.
+  See our comapatibility guide for [Mac](/docs/desktop/mac#compatibility), [Windows](/docs/desktop/windows#compatibility), and [Linux](docs/desktop/linux).
 
   GPU-wise, Jan supports:
   - NVIDIA GPUs (CUDA)
   - AMD GPUs (Vulkan)
   - Intel Arc GPUs (Vulkan) 
   - Other GPUs with Vulkan support
+
+
 </FAQBox>
 
-<FAQBox title="Do you use my data?">
+<FAQBox title="Does Jan use my data?">
  No data is collected. Everything stays local on your device.
  <Callout type="warning">
 When using cloud AI services (like GPT-4 or Claude) through Jan, their data collection is outside our control. Please check their privacy policies.
 </Callout>
- You can help improve Jan by choosing to opt in anonymous basic usage data (like feature usage and user counts). Even so, your chats and personal information are never collected. Read more about what data you can contribute to us at [Privacy](./docs/privacy.mdx).
+ You can help improve Jan by choosing to opt in anonymous basic usage data. Even so, your chats and personal information are never collected. Read more about what data you can contribute to us at [Privacy](./docs/privacy.mdx).
 </FAQBox>
 
 
@@ -104,35 +106,31 @@ When using cloud AI services (like GPT-4 or Claude) through Jan, their data coll
 </FAQBox>
 
 <FAQBox title="How does Jan ensure my data remains private?">
-  Jan prioritizes your privacy by running open-source AI models 100% offline on your computer. Conversations, documents, and files stay on your device in the Jan Data Folder located at:
+  Jan prioritizes your privacy by running open-source AI models 100% offline on your computer. Conversations, documents, and files stay on your device in [Jan Data Folder](/docs/data-folder) located at:
   - Windows: `%APPDATA%/Jan/data`
   - Linux: `$XDG_CONFIG_HOME/Jan/data` or `~/.config/Jan/data`
   - macOS: `~/Library/Application Support/Jan/data`
 </FAQBox>
 
-<FAQBox title="What does Jan stand for?">
-  Jan stands for “Just a Name". We are, admittedly, bad at marketing 😂.
-</FAQBox>
-
 <FAQBox title="Can I use Jan without an internet connection?">
-  Yes, Jan can run without an internet connection, but you'll need to download a local model first. Once you've downloaded your preferred models, Jan will work entirely offline by default.
+  Yes, Jan can run without an internet connection, but you'll need to [download a local model](/docs/models/manage-models#1-download-from-jan-hub-recommended) first. Once you've downloaded your preferred models, Jan will work entirely offline by default.
 </FAQBox>
 
 <FAQBox title="Are there any costs associated with using Jan?">
   Jan is free and open-source. There are no subscription fees or hidden costs for all local models & features.
 
-  To use cloud AI models (like GPT-4 or Claude):
+  To use [cloud AI models](/docs/models/manage-models#cloud-model) (like GPT-4 or Claude):
   - You'll need to have your own API keys & pay the standard rates charged by those providers.
   - Jan doesn't add any markup.
 
 </FAQBox>
 <FAQBox title="What types of AI models can I download or import with Jan?">
-  - Models from Jan's Hub are recommended for best compatibility.
-  - You can also import GGUF models from Hugging Face or your device.
+  - Models from [Jan Hub](/docs/models/manage-models#1-download-from-jan-hub-recommended) are recommended for best compatibility.
+  - You can also [import GGUF models](/docs/models/manage-models#2-import-from-hugging-face) from Hugging Face or from your local files.
 </FAQBox>
 
 <FAQBox title="How do I customize Jan using the programmable API?">
-Jan has an extensible architecture like VSCode and Obsidian - you can build custom features using our extensions API. Most of Jan's features are actually built as extensions.
+Jan has an extensible architecture like VSCode and Obsidian - you can build custom features using our extensions API. Most of Jan's features are actually built as [extensions](/docs/extensions).
 </FAQBox>
 
 <FAQBox title="How can I contribute to Jan's development or suggest features?">
@@ -145,6 +143,7 @@ Jan has an extensible architecture like VSCode and Obsidian - you can build cust
 
 <FAQBox title="How do I troubleshoot issues with installing or using Jan?">
   For troubleshooting, please visit [Troubleshooting](./docs/troubleshooting.mdx).
+
   In case you can't find what you need in our troubleshooting guide, please reach out to us for extra help on our [Discord](https://discord.com/invite/FTk2MvZwJH) in the **#🆘|get-help** channel.
 </FAQBox>
 
@@ -154,6 +153,10 @@ Jan has an extensible architecture like VSCode and Obsidian - you can build cust
   - Fork and build from our [GitHub](https://github.com/janhq/jan) repository.
 </FAQBox>
 
+<FAQBox title="What does Jan stand for?">
+  Jan stands for “Just a Name". We are, admittedly, bad at marketing 😂.
+</FAQBox>
+
 <FAQBox title="Are you hiring?">
   Yes! We love hiring from our community. Check out our open positions at [Careers](https://homebrew.bamboohr.com/careers).
 </FAQBox>