diff --git a/docs/src/pages/docs/_meta.json b/docs/src/pages/docs/_meta.json index a5893836b..6091efd7f 100644 --- a/docs/src/pages/docs/_meta.json +++ b/docs/src/pages/docs/_meta.json @@ -11,7 +11,7 @@ "quickstart": { "title": "Quickstart" }, - "desktop": "Desktop", + "desktop": "Installation", "data-folder": "Jan Data Folder", "privacy": "Privacy", "user-guides": { diff --git a/docs/src/pages/docs/desktop.mdx b/docs/src/pages/docs/desktop.mdx index c7f0de4c9..ba59ae0da 100644 --- a/docs/src/pages/docs/desktop.mdx +++ b/docs/src/pages/docs/desktop.mdx @@ -1,5 +1,5 @@ --- -title: Desktop Installation +title: Installation description: Jan is a ChatGPT-alternative that runs on your computer, with a local API server. keywords: [ @@ -20,7 +20,7 @@ keywords: import { Cards, Card } from 'nextra/components' import childPages from './desktop/_meta.json'; -# Desktop Installation +# Installation
diff --git a/docs/src/pages/docs/desktop/mac.mdx b/docs/src/pages/docs/desktop/mac.mdx index b1f952da7..0e4dbd233 100644 --- a/docs/src/pages/docs/desktop/mac.mdx +++ b/docs/src/pages/docs/desktop/mac.mdx @@ -31,50 +31,37 @@ Jan has been developed as a Mac Universal application, allowing it to run native ## Compatibility Ensure that your system meets the following requirements to use Jan effectively: - + - - -- MacOSX 13.6 or higher. - - -- 8GB for running up to 3B models. -- 16GB for running up to 7B models. -- 32GB for running up to 13B models. - - -- At least 10GB for app and model download. - - - - - - -- MacOSX 13.6 or higher. - - -- 8GB for running up to 3B models. -- 16GB for running up to 7B models. -- 32GB for running up to 13B models. +- **Operating System:** MacOSX 13.6 or higher +- **Memory:** + - 8GB for running up to 3B models + - 16GB for running up to 7B models + - 32GB for running up to 13B models Apple Silicon Macs leverage Metal for GPU acceleration, providing faster performance than Intel Macs, which rely solely on CPU processing. - +- **Disk:** At least 10GB for app and model download -- At least 10GB for app and model download. - - +- **Operating System:** MacOSX 13.6 or higher +- **Memory:** + - 8GB for running up to 3B models + - 16GB for running up to 7B models + - 32GB for running up to 13B models +- **Disk:** At least 10GB for app and model download + ## Installing Jan To install Jan, follow the steps below: -### Step 1: Download the Jan Application +### Step 1: Download Jan Application -Jan provides two types of releases: - + +Jan provides 3 types of releases: + #### Stable Releases @@ -88,9 +75,8 @@ Make sure to verify the URL to ensure that it's the official Jan website and Git -#### Nightly Releases -Nightly Releases let you test out new features, which may be buggy: +Beta releases let you test out new features, which may be buggy: - **Jan GitHub repository**: [Github](https://github.com/janhq/jan/actions/workflows/jan-electron-build-nightly.yml) @@ -99,6 +85,8 @@ Keep in mind that this build might crash frequently and may contain bugs! + + ### Step 2: Install the Jan Application 1. Once you have downloaded the Jan app `.dmg` file, open the file. @@ -106,20 +94,8 @@ Keep in mind that this build might crash frequently and may contain bugs! 3. Wait for the installation process. 4. Once installed, you can access Jan on your machine. -#### Install Jan with Homebrew -You can also install Jan using the following Homebrew command: - -```bash -brew install --cask jan -``` - - -- Ensure that you have installed Homebrew and its dependencies. -- Homebrew package installation is currently limited to **Apple Silicon Macs**, with upcoming support for Windows and Linux. - - -## Data Folder +## Jan Data Folder By default, Jan is installed in the following directory: diff --git a/docs/src/pages/docs/quickstart.mdx b/docs/src/pages/docs/quickstart.mdx index 815926e24..89077df5d 100644 --- a/docs/src/pages/docs/quickstart.mdx +++ b/docs/src/pages/docs/quickstart.mdx @@ -1,5 +1,5 @@ --- -title: Desktop installation +title: Installation description: Get started quickly with Jan, a ChatGPT-alternative that runs on your own computer, with a local API server. Learn how to install Jan and select an AI model to start chatting. sidebar_position: 2 keywords: