Skip to content
This repository has been archived by the owner on Oct 14, 2024. It is now read-only.

docs: Hide empty contents, fix hub page and updated quickstart content #35

Merged
merged 3 commits into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 0 additions & 18 deletions docs/developer/05-framework/03-engineering/fine-tuning.md

This file was deleted.

20 changes: 0 additions & 20 deletions docs/developer/05-framework/03-engineering/prompts.md

This file was deleted.

90 changes: 87 additions & 3 deletions docs/guides/get-started/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

<Tabs>
<TabItem value="mac" label = "Mac" default>
Expand Down Expand Up @@ -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.

:::

Expand Down Expand Up @@ -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.

:::

</TabItem>
<TabItem value = "server" label = "Server-Side">

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.

:::

Expand Down
60 changes: 32 additions & 28 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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/',
Expand All @@ -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/',
Expand All @@ -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/',
Expand Down Expand Up @@ -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/',
Expand All @@ -441,6 +441,10 @@ const config = {
from: '/chat',
to: '/guides/threads/',
},
{
from: '/docs/engineering/',
to: '/developer/engineering/',
},
// {
// from: '/docs/modules/assistants',
// to: '/developer/assistant/',
Expand Down Expand Up @@ -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',
Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function HomepageHeader() {
const { siteConfig } = useDocusaurusContext();

return (
<header className="bg-white dark:bg-gray-800 py-16 h-[20%] 2xl:h-[80vh] text-center relative overflow-hidden">
<header className="bg-white dark:bg-gray-800 py-16 h-[20%] 2xl:h-[50vh] text-center relative overflow-hidden">
<div className="bg-custom-img w-full h-full absolute top-0 left-0 bg-cover bg-center"></div>
<div className="container relative z-10">
<Heading as="h1" className="text-2xl lg:text-3xl xl:text-5xl 2xl:text-7xl font-semibold text-white dark:text-gray-200 mb-8 mt-8 2xl:mt-24 2xl:mb-16">
Expand All @@ -27,7 +27,7 @@ function HomepageHeader() {
insight={true}
/>
</div>
<p className="text-lg md:text-xl xl:text-2xl 2xl:text-4xl text-white dark:text-gray-200 mt-8 xl:mt-12">
<p className="text-lg md:text-xl xl:text-2xl 2xl:text-4xl text-white dark:text-gray-200 mt-8 xl:mt-12 2xl:mt-16">
Open-source ChatGPT alternative that runs 100% offline on your computer.
</p>
</div>
Expand Down
Loading