From 090684b0f7419969ed7efdff932490e68ae682b8 Mon Sep 17 00:00:00 2001 From: hieu-jan <150573299+hieu-jan@users.noreply.github.com> Date: Fri, 24 Nov 2023 10:50:21 +0900 Subject: [PATCH 1/3] docs: improve installation --- docs/docs/install/linux.md | 24 +++++++++++++++++++----- docs/docs/install/mac.md | 34 +++++++++++++++++++++++++++++----- docs/docs/install/windows.md | 4 ++-- 3 files changed, 50 insertions(+), 12 deletions(-) diff --git a/docs/docs/install/linux.md b/docs/docs/install/linux.md index 09162b60f..a7af581c4 100644 --- a/docs/docs/install/linux.md +++ b/docs/docs/install/linux.md @@ -2,15 +2,29 @@ title: Linux --- -# Jan on Linux +# Installing Jan on Linux ## Installation -1. To download the lastest version of Jan on Linux, please visit the [Jan's homepage](https://jan.ai/). -2. For Debian/Ubuntu-based distributions, the recommended installation method is through the `.deb` package (64-bit). This can be done either through the graphical software center, if available, or via the command line using the following: +Jan is available for download via our homepage, [https://jan.ai](https://jan.ai/). + +For Linux, the download should be available as a `.deb` file in the following format. + ```bash -sudo apt install ./jan-linux-amd64-.deb -# sudo apt install ./jan-linux-arm64-0.3.1.deb +jan-linux-amd64-{version}.deb +``` + +The typical installation process takes around a minute. + +### GitHub Releases + +Jan is also available from [Jan's GitHub Releases](https://github.com/janhq/jan/releases) page, with a recommended [latest stable release](https://github.com/janhq/jan/releases/latest). + +Within the Releases' assets, you will find the following files for Linux: + +```bash +# Debian Linux distribution +jan-linux-amd64-{version}.deb ``` ## Uninstall Jan diff --git a/docs/docs/install/mac.md b/docs/docs/install/mac.md index 5e4f0ef48..77a5ddf16 100644 --- a/docs/docs/install/mac.md +++ b/docs/docs/install/mac.md @@ -2,13 +2,37 @@ title: Mac --- -# Jan on MacOS +# Installing Jan on MacOS ## Installation -1. To download the lastest version of Jan on MacOS, please visit the [Jan's homepage](https://jan.ai/). -2. On the homepage, please choose the appropriate release version for your system architecture as follows: - - Intel Mac: `jan-mac-x64-.dmg` - - Apple Silicon Mac: `jan-mac-arm64-.dmg` + +Jan is available for download via our homepage, [https://jan.ai/](https://jan.ai/). + +For MacOS, the download should be available as a `.dmg` file in the following format. + +```bash +# Intel Mac +jan-mac-x64-.dmg +# Apple Silicon Mac +jan-mac-arm64-.dmg +``` + +The typical installation process taks around a minute. + +## GitHub Releases +Jan is also available from [Jan's GitHub Releases](https://github.com/janhq/jan/releases) page, with a recommended [latest stable release](https://github.com/janhq/jan/releases/latest). + +Within the Releases' assets, you will find the following files for MacOS: + +```bash +# Intel Mac (dmg file and zip file) +jan-mac-x64-{version}.dmg +jan-mac-x64-{version}.zip + +# Apple Silicon Mac (dmg file and zip file) +jan-mac-arm64-{version}.dmg +jan-mac-arm64-{version}.zip +``` ## Uninstall Jan As Jan is development mode, you might get stuck on a broken build diff --git a/docs/docs/install/windows.md b/docs/docs/install/windows.md index fd3f173c3..ecf57f51f 100644 --- a/docs/docs/install/windows.md +++ b/docs/docs/install/windows.md @@ -16,9 +16,9 @@ jan-win-x64-{version}.exe The typical installation process takes around a minute. -### Github Releases +### GitHub Releases -Jan is also available from [Jan's Github Releases](https://github.com/janhq/jan/releases) page, with a recommended [latest stable release](https://github.com/janhq/jan/releases/latest). +Jan is also available from [Jan's GitHub Releases](https://github.com/janhq/jan/releases) page, with a recommended [latest stable release](https://github.com/janhq/jan/releases/latest). Within the Releases' assets, you will find the following files for Windows: From 8d00d76fa422ccbdbbc2eaa4549b596933735af5 Mon Sep 17 00:00:00 2001 From: hieu-jan <150573299+hieu-jan@users.noreply.github.com> Date: Fri, 24 Nov 2023 10:53:36 +0900 Subject: [PATCH 2/3] docs: point /docs as first page --- docs/docs/intro/introduction.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/intro/introduction.md b/docs/docs/intro/introduction.md index 3bff25015..a483b10cc 100644 --- a/docs/docs/intro/introduction.md +++ b/docs/docs/intro/introduction.md @@ -1,6 +1,6 @@ --- title: Introduction -slug: /intro +slug: /docs --- Jan is a ChatGPT-alternative that runs on your own computer, with a [local API server](/api). From 7397f491abe9c5fa2b5aa224a10ba3e3d9c2287b Mon Sep 17 00:00:00 2001 From: hieu-jan <150573299+hieu-jan@users.noreply.github.com> Date: Fri, 24 Nov 2023 11:24:56 +0900 Subject: [PATCH 3/3] docs: update path --- docs/docs/install/mac.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/install/mac.md b/docs/docs/install/mac.md index 77a5ddf16..21ecdb54c 100644 --- a/docs/docs/install/mac.md +++ b/docs/docs/install/mac.md @@ -12,9 +12,9 @@ For MacOS, the download should be available as a `.dmg` file in the following fo ```bash # Intel Mac -jan-mac-x64-.dmg +jan-mac-x64-{version}.dmg # Apple Silicon Mac -jan-mac-arm64-.dmg +jan-mac-arm64-{version}.dmg ``` The typical installation process taks around a minute.