From 7d370aadf1578087dc0b345078caa951880220a0 Mon Sep 17 00:00:00 2001 From: Arista Indrajaya Date: Mon, 25 Mar 2024 15:07:04 +0700 Subject: [PATCH 1/3] docs: Fix the space on a large screen by decreasing the header high --- src/pages/docs.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/pages/docs.js b/src/pages/docs.js index 505969d6..846f0921 100644 --- a/src/pages/docs.js +++ b/src/pages/docs.js @@ -12,7 +12,7 @@ function HomepageHeader() { const { siteConfig } = useDocusaurusContext(); return ( -
+
@@ -27,7 +27,7 @@ function HomepageHeader() { insight={true} />
-

+

Open-source ChatGPT alternative that runs 100% offline on your computer.

From b67a9b9aee4b1caef822be42bbb506c22b2afb53 Mon Sep 17 00:00:00 2001 From: Arista Indrajaya Date: Mon, 25 Mar 2024 15:19:01 +0700 Subject: [PATCH 2/3] docs: Fixed redirects, hide ecosystem and product navbar and also hide fine tuning ai + prompt empty pages from developer. --- .../03-engineering/fine-tuning.md | 18 ------ .../05-framework/03-engineering/prompts.md | 20 ------- docusaurus.config.js | 60 ++++++++++--------- 3 files changed, 32 insertions(+), 66 deletions(-) delete mode 100644 docs/developer/05-framework/03-engineering/fine-tuning.md delete mode 100644 docs/developer/05-framework/03-engineering/prompts.md diff --git a/docs/developer/05-framework/03-engineering/fine-tuning.md b/docs/developer/05-framework/03-engineering/fine-tuning.md deleted file mode 100644 index dac7cf54..00000000 --- a/docs/developer/05-framework/03-engineering/fine-tuning.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 'Fine-tuning' -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: - [ - Jan, - Rethink the Computer, - local AI, - privacy focus, - free and open source, - private and offline, - conversational AI, - no-subscription fee, - large language models, - ] ---- - -Todo: @hiro diff --git a/docs/developer/05-framework/03-engineering/prompts.md b/docs/developer/05-framework/03-engineering/prompts.md deleted file mode 100644 index 5897309d..00000000 --- a/docs/developer/05-framework/03-engineering/prompts.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Prompts -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: - [ - Jan, - Rethink the Computer, - local AI, - privacy focus, - free and open source, - private and offline, - conversational AI, - no-subscription fee, - large language models, - ] ---- - -- [ ] /prompts folder -- [ ] How to add to prompts -- [ ] Assistants can have suggested Prompts diff --git a/docusaurus.config.js b/docusaurus.config.js index 9b549bde..5431dbdc 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -325,10 +325,10 @@ const config = { // from: '/guides/mac/', // to: '/guides/install/mac/', // }, - { - from: '/specs/fine-tuning/', - to: '/developer/framework/engineering/fine-tuning/', - }, + // { + // from: '/specs/fine-tuning/', + // to: '/developer/framework/engineering/fine-tuning/', + // }, { from: '/guides/server/', to: '/guides/local-api/', @@ -345,10 +345,10 @@ const config = { from: '/api/', to: '/api-reference/', }, - { - from: '/products/desktop', - to: '/desktop/', - }, + // { + // from: '/products/desktop', + // to: '/desktop/', + // }, { from: '/developers/plugins/azure-openai', to: '/guides/engines/openai/', @@ -357,10 +357,10 @@ const config = { // from: '/getting-started/install/mac', // to: '/guides/install/mac/', // }, - { - from: '/guides/fine-tuning/what-models-can-be-fine-tuned', - to: '/developer/framework/engineering/fine-tuning/', - }, + // { + // from: '/guides/fine-tuning/what-models-can-be-fine-tuned', + // to: '/developer/framework/engineering/fine-tuning/', + // }, // { // from: '/guides/linux/', // to: '/guides/install/linux/', @@ -421,10 +421,10 @@ const config = { from: '/docs/api-reference/models', to: '/api-reference#tag/models/get/models', }, - { - from: '/docs/guides/fine-tuning', - to: '/developer/framework/engineering/fine-tuning/', - }, + // { + // from: '/docs/guides/fine-tuning', + // to: '/developer/framework/engineering/fine-tuning/', + // }, { from: '/docs/specs/files', to: '/developer/framework/engineering/files/', @@ -441,6 +441,10 @@ const config = { from: '/chat', to: '/guides/threads/', }, + { + from: '/docs/engineering/', + to: '/developer/engineering/', + }, // { // from: '/docs/modules/assistants', // to: '/developer/assistant/', @@ -646,18 +650,18 @@ const config = { }, ], }, - { - type: 'docSidebar', - sidebarId: 'productSidebar', - position: 'left', - label: 'Product', - }, - { - type: 'docSidebar', - sidebarId: 'ecosystemSidebar', - position: 'left', - label: 'Ecosystem', - }, + // { + // type: 'docSidebar', + // sidebarId: 'productSidebar', + // position: 'left', + // label: 'Product', + // }, + // { + // type: 'docSidebar', + // sidebarId: 'ecosystemSidebar', + // position: 'left', + // label: 'Ecosystem', + // }, { to: 'download', position: 'left', From 1ef9c19e086c50f21ebace4d87ad3592a0f56a86 Mon Sep 17 00:00:00 2001 From: Arista Indrajaya Date: Mon, 25 Mar 2024 15:19:34 +0700 Subject: [PATCH 3/3] docs: Updated quickstart content --- docs/guides/get-started/quickstart.mdx | 90 +++++++++++++++++++++++++- 1 file changed, 87 insertions(+), 3 deletions(-) diff --git a/docs/guides/get-started/quickstart.mdx b/docs/guides/get-started/quickstart.mdx index 243e4a59..46971ca1 100644 --- a/docs/guides/get-started/quickstart.mdx +++ b/docs/guides/get-started/quickstart.mdx @@ -29,7 +29,7 @@ import model from './asset/model.gif'; To get started quickly with Jan, follow the steps below: -## Step 1: Get Jan Desktop +## Step 1: Install Desktop @@ -107,7 +107,7 @@ Homebrew package installation is currently limited to **Apple Silicon Macs**, wi :::warning -If you are stuck in a broken build, go to the [Broken Build](/guides/common-error/broken-build) section of Common Errors. +If you are stuck in a broken build, go to the [Broken Build](/troubleshooting/#broken-build) section of Common Errors. ::: @@ -175,7 +175,91 @@ If you are stuck in a broken build, go to the [Broken Build](/guides/common-erro :::warning -If you are stuck in a broken build, go to the [Broken Build](/guides/common-error/broken-build) section of Common Errors. +If you are stuck in a broken build, go to the [Broken Build](/troubleshooting/#broken-build) section of Common Errors. + +::: + + + + + To install Jan from source, follow the steps below: + +### Pre-requisites + +Before proceeding with the installation of Jan from source, ensure that the following software versions are installed on your system: + +- Node.js version 20.0.0 or higher +- Yarn version 1.22.0 or higher + +### Install Jan Development Build + +1. Clone the Jan repository from GitHub by using the following command: + +```bash +git clone https://github.com/janhq/jan +git checkout DESIRED_BRANCH +cd jan +``` + +2. Install the required dependencies by using the following Yarn command: + +```bash +yarn install + +# Build core module +yarn build:core + +# Packing base plugins +yarn build:plugins + +# Packing uikit +yarn build:uikit +``` + +3. Run the development server. + +```bash +yarn dev +``` + +This will start the development server and open the desktop app. During this step, you may encounter notifications about installing base plugins. Simply click **OK** and **Next** to continue. + +### Install Jan Production Build + +1. Clone the Jan repository from GitHub by using the following command: + +```bash +git clone https://github.com/janhq/jan +cd jan +``` + +2. Install the required dependencies by using the following Yarn command: + +```bash +yarn install + +# Build core module +yarn build:core + +# Packing base plugins +yarn build:plugins + +# Packing uikit +yarn build:uikit +``` + +3. Run the production server. + +```bash +yarn +``` + +This completes the installation process for Jan from source. The production-ready app for macOS can be found in the dist folder. + + +:::warning + +If you are stuck in a broken build, go to the [Broken Build](/troubleshooting/#broken-build) section of Common Errors. :::