From a9769b5542fd02be3ba90db236e254c8ace84f1d Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Fri, 5 Jan 2024 18:43:06 +0700 Subject: [PATCH 1/3] docs: initial nightly build docs --- .../02-installation/05-nightly-build.md | 19 +++++++++++++++++++ .../{05-hardware.md => 06-hardware.md} | 0 2 files changed, 19 insertions(+) create mode 100644 docs/docs/guides/02-installation/05-nightly-build.md rename docs/docs/guides/02-installation/{05-hardware.md => 06-hardware.md} (100%) diff --git a/docs/docs/guides/02-installation/05-nightly-build.md b/docs/docs/guides/02-installation/05-nightly-build.md new file mode 100644 index 000000000..23e1230f4 --- /dev/null +++ b/docs/docs/guides/02-installation/05-nightly-build.md @@ -0,0 +1,19 @@ +--- +title: Install Nightly Build +slug: /install/nightly +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, + nightly build, + ] +--- + +https://github.com/janhq/jan?tab=readme-ov-file#download \ No newline at end of file diff --git a/docs/docs/guides/02-installation/05-hardware.md b/docs/docs/guides/02-installation/06-hardware.md similarity index 100% rename from docs/docs/guides/02-installation/05-hardware.md rename to docs/docs/guides/02-installation/06-hardware.md From fccb8b54152ba932aea7b25f414b40c73e299ed1 Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Fri, 5 Jan 2024 22:57:57 +0700 Subject: [PATCH 2/3] docs: finalize nightly release guide --- .../02-installation/05-nightly-build.md | 36 +++++++++++++++++-- docs/docs/guides/02-installation/README.mdx | 4 +-- 2 files changed, 35 insertions(+), 5 deletions(-) diff --git a/docs/docs/guides/02-installation/05-nightly-build.md b/docs/docs/guides/02-installation/05-nightly-build.md index 23e1230f4..f6fdebd84 100644 --- a/docs/docs/guides/02-installation/05-nightly-build.md +++ b/docs/docs/guides/02-installation/05-nightly-build.md @@ -1,5 +1,5 @@ --- -title: Install Nightly Build +title: Nightly Release slug: /install/nightly description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. keywords: @@ -12,8 +12,38 @@ keywords: conversational AI, no-subscription fee, large language model, - nightly build, + nightly release, ] --- -https://github.com/janhq/jan?tab=readme-ov-file#download \ No newline at end of file +:::warning + +- Nightly releases are cutting-edge verions that include the latest features. However, they are highly unstable and may contain bugs. + +::: + +## Where to Find Nightly Releases + +- **Jan's GitHub Repository**: Visit the [Download section](https://github.com/janhq/jan?tab=readme-ov-file#download) of Jan's GitHub repository for the latest nightly release. + +- **Discord Channel**: Nightly releases are also announced in our [Discord channel](https://discord.com/channels/1107178041848909847/1191638499355537418). + +## Automatic Updates + +Once you install a nightly build, the application will automatically prompt you to update each time it is restarted, ensuring you always have the latest version. + +## Running Stable and Nightly Versions Simultaneously + +If you wish to use both the stable and nightly versions of Jan, follow these steps: + +1. Install the stable version as usual. +2. For the nightly build, choose a different installation directory to avoid conflicts. +3. Ensure that you clearly label or create shortcuts for each version to avoid confusion. + +

+ +:::tip + +- Engage with [our community on Discord](https://discord.gg/Dt7MxDyNNZ) to share feedback or get support for any issues you encounter. + +::: diff --git a/docs/docs/guides/02-installation/README.mdx b/docs/docs/guides/02-installation/README.mdx index 00dc4ef57..0721bb866 100644 --- a/docs/docs/guides/02-installation/README.mdx +++ b/docs/docs/guides/02-installation/README.mdx @@ -28,9 +28,9 @@ In this quickstart we'll show you how to: ### Installation -- To download the latest stable release: https://jan.ai/ +- To download the latest stable release: https://jan.ai/ or visit the [GitHub Releases](https://github.com/janhq/jan/releases) to download any previous release. -- To download a nightly release (highly unstable but lots of new features): https://github.com/janhq/jan/releases +- To download a nightly release (highly unstable but lots of new features), please check out the [Download section](https://github.com/janhq/jan?tab=readme-ov-file#download) on our repository. - For a detailed installation guide for your operating system, see the following: From c04853e920a676a4ede7877063c80f365c485a48 Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Fri, 5 Jan 2024 22:58:45 +0700 Subject: [PATCH 3/3] docs: correct typo --- docs/docs/guides/02-installation/05-nightly-build.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/guides/02-installation/05-nightly-build.md b/docs/docs/guides/02-installation/05-nightly-build.md index f6fdebd84..5a84f3410 100644 --- a/docs/docs/guides/02-installation/05-nightly-build.md +++ b/docs/docs/guides/02-installation/05-nightly-build.md @@ -18,7 +18,7 @@ keywords: :::warning -- Nightly releases are cutting-edge verions that include the latest features. However, they are highly unstable and may contain bugs. +- Nightly releases are cutting-edge versions that include the latest features. However, they are highly unstable and may contain bugs. :::