Refactor structure for User Guide
This commit is contained in:
Daniel
parent
ce37261133
commit
663016de58
@ -1,8 +1,9 @@
|
|||||||
---
|
---
|
||||||
sidebar_position: 5
|
|
||||||
title: Cloud Native
|
title: Cloud Native
|
||||||
---
|
---
|
||||||
|
|
||||||
|
# Installing Jan Cloud Native
|
||||||
|
|
||||||
Cloud Native is useful when you want to deploy Jan to a shared/remote/cloud server, rather than running it as a local Desktop app.
|
Cloud Native is useful when you want to deploy Jan to a shared/remote/cloud server, rather than running it as a local Desktop app.
|
||||||
|
|
||||||
> This is an experimental feature - expect breaking changes!
|
> This is an experimental feature - expect breaking changes!
|
||||||
@ -35,7 +36,7 @@ Open your browser at [http://localhost:4000](http://localhost:4000)
|
|||||||
|
|
||||||
### Architecture
|
### Architecture
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### TODOs
|
### TODOs
|
||||||
|
|
||||||
3
docs/docs/guides/install/install.md
Normal file
3
docs/docs/guides/install/install.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
title: Installation
|
||||||
|
---
|
||||||
@ -1,16 +1,18 @@
|
|||||||
---
|
---
|
||||||
title: Installing Jan on Linux
|
title: Linux
|
||||||
sidebar_position: 4
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Linux users
|
# Installing Jan on Linux
|
||||||
## Step 1: Download the Installer
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### Step 1: Download the Installer
|
||||||
To begin using 👋Jan.ai on your Windows computer, follow these steps:
|
To begin using 👋Jan.ai on your Windows computer, follow these steps:
|
||||||
|
|
||||||
1. Visit [Jan.ai](https://jan.ai/).
|
1. Visit [Jan.ai](https://jan.ai/).
|
||||||
2. Click on the "Download for Windows" button to download the Jan Installer.
|
2. Click on the "Download for Windows" button to download the Jan Installer.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
|
|
||||||
@ -34,37 +36,42 @@ For AMD GPU. You can download it from your Linux distro's package manager or fro
|
|||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Step 2: Download your first model
|
### Step 2: Download your first model
|
||||||
Now, let's get your first model:
|
Now, let's get your first model:
|
||||||
|
|
||||||
1. After installation, you'll find the 👋Jan application icon on your desktop. Double-click to open it.
|
1. After installation, you'll find the 👋Jan application icon on your desktop. Double-click to open it.
|
||||||
|
|
||||||
2. Welcome to the Jan homepage. Click on "Explore Models" to see the Model catalog.
|
2. Welcome to the Jan homepage. Click on "Explore Models" to see the Model catalog.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
3. You can also see different quantized versions by clicking on "Show Available Versions."
|
3. You can also see different quantized versions by clicking on "Show Available Versions."
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
> Note: Choose a model that matches your computer's memory and RAM.
|
> Note: Choose a model that matches your computer's memory and RAM.
|
||||||
|
|
||||||
4. Select your preferred model and click "Download."
|
4. Select your preferred model and click "Download."
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Step 3: Start the model
|
### Step 3: Start the model
|
||||||
Once your model is downloaded. Go to "My Models" and then click "Start Model."
|
Once your model is downloaded. Go to "My Models" and then click "Start Model."
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Step 4: Start the conversations
|
|
||||||
|
### Step 4: Start the conversations
|
||||||
Now you're ready to start using 👋Jan.ai for conversations:
|
Now you're ready to start using 👋Jan.ai for conversations:
|
||||||
|
|
||||||
Click "Chat" and begin your first conversation by selecting "New conversation."
|
Click "Chat" and begin your first conversation by selecting "New conversation."
|
||||||
|
|
||||||
You can also check the CPU and Memory usage of the computer.
|
You can also check the CPU and Memory usage of the computer.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai.
|
That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai.
|
||||||
|
|
||||||
|
## Uninstallation
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
@ -1,48 +1,52 @@
|
|||||||
---
|
---
|
||||||
title: Installing Jan on Mac
|
title: Mac
|
||||||
sidebar_position: 2
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Mac users
|
## Installation
|
||||||
## Step 1: Download the Installer
|
|
||||||
|
### Step 1: Download the Installer
|
||||||
To begin using 👋Jan.ai on your Windows computer, follow these steps:
|
To begin using 👋Jan.ai on your Windows computer, follow these steps:
|
||||||
|
|
||||||
1. Visit [Jan.ai](https://jan.ai/).
|
1. Visit [Jan.ai](https://jan.ai/).
|
||||||
2. Click on the "Download for Windows" button to download the Jan Installer.
|
2. Click on the "Download for Windows" button to download the Jan Installer.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Step 2: Download your first model
|
### Step 2: Download your first model
|
||||||
Now, let's get your first model:
|
Now, let's get your first model:
|
||||||
|
|
||||||
1. After installation, you'll find the 👋Jan application icon on your desktop. Open it.
|
1. After installation, you'll find the 👋Jan application icon on your desktop. Open it.
|
||||||
|
|
||||||
2. Welcome to the Jan homepage. Click on "Explore Models" to see the Model catalog.
|
2. Welcome to the Jan homepage. Click on "Explore Models" to see the Model catalog.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
3. You can also see different quantized versions by clicking on "Show Available Versions."
|
3. You can also see different quantized versions by clicking on "Show Available Versions."
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
> Note: Choose a model that matches your computer's memory and RAM.
|
> Note: Choose a model that matches your computer's memory and RAM.
|
||||||
|
|
||||||
4. Select your preferred model and click "Download."
|
4. Select your preferred model and click "Download."
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Step 3: Start the model
|
### Step 3: Start the model
|
||||||
Once your model is downloaded. Go to "My Models" and then click "Start Model."
|
Once your model is downloaded. Go to "My Models" and then click "Start Model."
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Step 4: Start the conversations
|
### Step 4: Start the conversations
|
||||||
Now you're ready to start using 👋Jan.ai for conversations:
|
Now you're ready to start using 👋Jan.ai for conversations:
|
||||||
|
|
||||||
Click "Chat" and begin your first conversation by selecting "New conversation."
|
Click "Chat" and begin your first conversation by selecting "New conversation."
|
||||||
|
|
||||||
You can also check the CPU and Memory usage of the computer.
|
You can also check the CPU and Memory usage of the computer.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai.
|
That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai.
|
||||||
|
|
||||||
|
## Uninstallation
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
@ -1,16 +1,16 @@
|
|||||||
---
|
---
|
||||||
title: Installing Jan on Windows
|
title: Windows
|
||||||
sidebar_position: 3
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Windows users
|
# Installing Jan on Windows
|
||||||
|
|
||||||
## Step 1: Download the Installer
|
## Step 1: Download the Installer
|
||||||
To begin using 👋Jan.ai on your Windows computer, follow these steps:
|
To begin using 👋Jan.ai on your Windows computer, follow these steps:
|
||||||
|
|
||||||
1. Visit [Jan.ai](https://jan.ai/).
|
1. Visit [Jan.ai](https://jan.ai/).
|
||||||
2. Click on the "Download for Windows" button to download the Jan Installer.
|
2. Click on the "Download for Windows" button to download the Jan Installer.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Step 2: Proceed the Windows Defender
|
## Step 2: Proceed the Windows Defender
|
||||||
|
|
||||||
@ -18,11 +18,11 @@ When you run the Jan Installer, Windows Defender may display a warning. Here's w
|
|||||||
|
|
||||||
1. Click "Run away" to accept and install 👋Jan.ai.
|
1. Click "Run away" to accept and install 👋Jan.ai.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
2. Wait for the 👋Jan.ai installation to complete.
|
1. Wait for the 👋Jan.ai installation to complete.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
|
|
||||||
@ -48,22 +48,22 @@ Now, let's get your first model:
|
|||||||
|
|
||||||
2. Welcome to the Jan homepage. Click on "Explore Models" to see the Model catalog.
|
2. Welcome to the Jan homepage. Click on "Explore Models" to see the Model catalog.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
3. You can also see different quantized versions by clicking on "Show Available Versions."
|
1. You can also see different quantized versions by clicking on "Show Available Versions."
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
> Note: Choose a model that matches your computer's memory and RAM.
|
> Note: Choose a model that matches your computer's memory and RAM.
|
||||||
|
|
||||||
4. Select your preferred model and click "Download."
|
1. Select your preferred model and click "Download."
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Step 4: Start the model
|
## Step 4: Start the model
|
||||||
Once your model is downloaded. Go to "My Models" and then click "Start Model."
|
Once your model is downloaded. Go to "My Models" and then click "Start Model."
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Step 5: Start the conversations
|
## Step 5: Start the conversations
|
||||||
Now you're ready to start using 👋Jan.ai for conversations:
|
Now you're ready to start using 👋Jan.ai for conversations:
|
||||||
@ -72,6 +72,6 @@ Click "Chat" and begin your first conversation by selecting "New conversation."
|
|||||||
|
|
||||||
You can also check the CPU and Memory usage of the computer.
|
You can also check the CPU and Memory usage of the computer.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai.
|
That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai.
|
||||||
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Concepts
|
title: Overview
|
||||||
sidebar_position: 1
|
slug: /guides
|
||||||
---
|
---
|
||||||
- Jan Platform: Desktop app/ Cloud native SaaS that can run on Linux, Windows, Mac, or even a Server that comes with extensibilities, toolbox, and state-of-the-art but optimized models for next-gen Apps.
|
- Jan Platform: Desktop app/ Cloud native SaaS that can run on Linux, Windows, Mac, or even a Server that comes with extensibilities, toolbox, and state-of-the-art but optimized models for next-gen Apps.
|
||||||
- Jan App: Next-gen App built on Jan Plaform as `portable intelligence` that can be run everywhere.
|
- Jan App: Next-gen App built on Jan Plaform as `portable intelligence` that can be run everywhere.
|
||||||
@ -1,9 +1,7 @@
|
|||||||
---
|
---
|
||||||
title: Cookbook
|
title: Engineering
|
||||||
---
|
---
|
||||||
|
|
||||||
# Internal Guidelines
|
|
||||||
|
|
||||||
## Connecting to Rigs
|
## Connecting to Rigs
|
||||||
|
|
||||||
### Pritunl Setup
|
### Pritunl Setup
|
||||||
@ -122,13 +122,13 @@ const config = {
|
|||||||
type: "docSidebar",
|
type: "docSidebar",
|
||||||
sidebarId: "guidesSidebar",
|
sidebarId: "guidesSidebar",
|
||||||
position: "left",
|
position: "left",
|
||||||
label: "User Guides",
|
label: "User Guide",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
type: "docSidebar",
|
type: "docSidebar",
|
||||||
sidebarId: "devSidebar",
|
sidebarId: "devSidebar",
|
||||||
position: "left",
|
position: "left",
|
||||||
label: "Developer",
|
label: "Developers",
|
||||||
},
|
},
|
||||||
// Navbar right
|
// Navbar right
|
||||||
{
|
{
|
||||||
|
|||||||
@ -29,23 +29,24 @@ const sidebars = {
|
|||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
|
||||||
// Autogenerate docs from /guides
|
|
||||||
guidesSidebar: [
|
guidesSidebar: [
|
||||||
|
"guides/overview",
|
||||||
{
|
{
|
||||||
type: "category",
|
type: "category",
|
||||||
label: "Guides",
|
label: "Installation",
|
||||||
collapsible: true,
|
collapsible: true,
|
||||||
collapsed: true,
|
collapsed: true,
|
||||||
|
link: { type: "doc", id: "guides/install/install" },
|
||||||
items: [
|
items: [
|
||||||
{
|
"guides/install/linux",
|
||||||
type: "autogenerated",
|
"guides/install/windows",
|
||||||
dirName: "guides",
|
"guides/install/mac",
|
||||||
},
|
"guides/install/cloud-native",
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
"guides/troubleshooting",
|
||||||
],
|
],
|
||||||
|
|
||||||
//
|
|
||||||
devSidebar: [
|
devSidebar: [
|
||||||
{
|
{
|
||||||
type: "category",
|
type: "category",
|
||||||
@ -83,53 +84,19 @@ const sidebars = {
|
|||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
// {
|
|
||||||
// type: "category",
|
|
||||||
// label: "Tutorials",
|
|
||||||
// collapsible: true,
|
|
||||||
// collapsed: false,
|
|
||||||
// items: [
|
|
||||||
// {
|
|
||||||
// type: "autogenerated",
|
|
||||||
// dirName: "tutorials",
|
|
||||||
// },
|
|
||||||
// ],
|
|
||||||
// },
|
|
||||||
// {
|
|
||||||
// type: "category",
|
|
||||||
// label: "Articles",
|
|
||||||
// collapsible: true,
|
|
||||||
// collapsed: false,
|
|
||||||
// items: [
|
|
||||||
// {
|
|
||||||
// type: "doc",
|
|
||||||
// label: "Nitro",
|
|
||||||
// id: "articles/nitro",
|
|
||||||
// },
|
|
||||||
// ],
|
|
||||||
// },
|
|
||||||
],
|
],
|
||||||
|
|
||||||
aboutSidebar: [
|
aboutSidebar: [
|
||||||
// {
|
|
||||||
// type: "category",
|
|
||||||
// label: "About Jan",
|
|
||||||
// collapsible: true,
|
|
||||||
// collapsed: true,
|
|
||||||
// link: { type: "doc", id: "about/about" },
|
|
||||||
// items: [
|
|
||||||
// "about/team",
|
|
||||||
// {
|
|
||||||
// type: "link",
|
|
||||||
// label: "Careers",
|
|
||||||
// href: "https://janai.bamboohr.com/careers",
|
|
||||||
// },
|
|
||||||
// ],
|
|
||||||
// },
|
|
||||||
{
|
{
|
||||||
type: "doc",
|
type: "doc",
|
||||||
|
label: "About Jan",
|
||||||
id: "about/about",
|
id: "about/about",
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
type: "link",
|
||||||
|
label: "Careers",
|
||||||
|
href: "https://janai.bamboohr.com/careers",
|
||||||
|
},
|
||||||
{
|
{
|
||||||
type: "category",
|
type: "category",
|
||||||
label: "Events",
|
label: "Events",
|
||||||
@ -151,9 +118,9 @@ const sidebars = {
|
|||||||
link: { type: "doc", id: "handbook/handbook" },
|
link: { type: "doc", id: "handbook/handbook" },
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
type: "category",
|
type: "doc",
|
||||||
label: "Engineering",
|
label: "Engineering",
|
||||||
items: ["handbook/engineering/internal"],
|
id: "handbook/engineering/engineering",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user