Restructure Documentation section

This commit is contained in:
Daniel 2023-11-18 17:18:34 +08:00
parent afb63b7e2b
commit 54225a34b8
38 changed files with 121 additions and 156 deletions

View File

@ -3,7 +3,7 @@ title: "Nov 23: Nvidia GenAI Day"
description: Nvidia's LLM Day description: Nvidia's LLM Day
--- ---
![](../../static/img/nvidia-llm-day-header.png) ![](/img/nvidia-llm-day-header.png)
## Nvidia GenAI Innovation Day ## Nvidia GenAI Innovation Day
@ -17,5 +17,5 @@ Jan will be at Nvidia's GenAI Innovation Day in Nov '23, focusing on Enterprise
### Programme ### Programme
![](../../static/img/nvidia-llm-day.png) ![](/img/nvidia-llm-day.png)

View File

@ -1,3 +0,0 @@
---
title: Hardware Acceleration
---

View File

@ -1,11 +0,0 @@
---
title: Powerful AI Models
---
- Run AI on your own hardware
- Llama2, StableDiffusion
- Rapidly growing ecosystem of open source, locally run AI
- Connect to cloud-based AI
- ChatGPT
- Claude
- Bard

View File

@ -1,12 +0,0 @@
---
title: Privacy and Data Security
---
- Privacy
- Data Security
- Optional Policy Engine for 3rd-party AIs
- Offline-ready
- Airgapped locations
- Prevent a data leak
- Shadow IT
- Personal Information being sent to ChatGPT, corporate IP

View File

@ -1,3 +0,0 @@
---
title: Extensions
---

View File

@ -1,3 +0,0 @@
---
title: Features
---

View File

@ -1,13 +0,0 @@
---
title: Unlimited Use
---
- Cost doesn't scale with usage
- Difficult to estimate cost of a project
- ChatGPT costs $2 per GPT-4 call with 32k context (what document would this be equivalent to?)
- Reading in documents is expensive
- Getting ChatGPT to ingest a codebase
- On the other hand
- No surprises at the end of the month
- Use as much as you want
- Predictable costs

View File

@ -1,42 +0,0 @@
---
title: Troubleshooting
sidebar_position: 5
---
# Jan.ai Troubleshooting Guide
Please note that 👋Jan is in "development mode," and you might encounter issues. If you need to reset your installation, follow these steps:
## Issue 1: Broken Build
As Jan is development mode, you might get stuck on a broken build.
To reset your installation:
1. Delete Jan from your `/Applications` folder
1. Delete Application data:
```sh
# Newer versions
rm -rf /Users/$(whoami)/Library/Application\ Support/jan
# Versions 0.2.0 and older
rm -rf /Users/$(whoami)/Library/Application\ Support/jan-electron
```
1. Clear Application cache:
```sh
rm -rf /Users/$(whoami)/Library/Caches/jan*
```
1. Use the following commands to remove any dangling backend processes:
```sh
ps aux | grep nitro
```
Look for processes like "nitro" and "nitro_arm_64," and kill them one by one with:
```sh
kill -9 <PID>
```

View File

@ -0,0 +1,3 @@
---
title: Build an Assistant
---

View File

@ -0,0 +1,3 @@
---
title: Model Management
---

View File

@ -0,0 +1,3 @@
---
title: Build a Module
---

View File

@ -0,0 +1,3 @@
---
title: Build a Theme
---

3
docs/docs/guide/tools.md Normal file
View File

@ -0,0 +1,3 @@
---
title: Build a Tool
---

View File

@ -12,7 +12,7 @@ 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.
![Jan Installer](../img/jan-download.png) ![Jan Installer](/img/jan-download.png)
:::tip :::tip
@ -43,22 +43,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.
![Explore models](../img/explore-model.png) ![Explore models](/img/explore-model.png)
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."
![Model versions](../img/model-version.png) ![Model versions](/img/model-version.png)
> 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."
![Downloading](../img/downloading.png) ![Downloading](/img/downloading.png)
### 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."
![Start model](../img/start-model.png) ![Start model](/img/start-model.png)
### Step 4: Start the conversations ### Step 4: Start the conversations
@ -68,7 +68,7 @@ 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.
![Chat](../img/chat.png) ![Chat](/img/chat.png)
That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai. That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai.

View File

@ -10,7 +10,7 @@ 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.
![Jan Installer](../img/jan-download.png) ![Jan Installer](/img/jan-download.png)
### 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:
@ -19,22 +19,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.
![Explore models](../img/explore-model.png) ![Explore models](/img/explore-model.png)
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."
![Model versions](../img/model-version.png) ![Model versions](/img/model-version.png)
> 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."
![Downloading](../img/downloading.png) ![Downloading](/img/downloading.png)
### 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."
![Start model](../img/start-model.png) ![Start model](/img/start-model.png)
### 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:
@ -43,10 +43,42 @@ 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.
![Chat](../img/chat.png) ![Chat](/img/chat.png)
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 ## Uninstallation
## Troubleshooting As Jan is development mode, you might get stuck on a broken build.
To reset your installation:
1. Delete Jan from your `/Applications` folder
2. Delete Application data:
```sh
# Newer versions
rm -rf /Users/$(whoami)/Library/Application\ Support/jan
# Versions 0.2.0 and older
rm -rf /Users/$(whoami)/Library/Application\ Support/jan-electron
```
3. Clear Application cache:
```sh
rm -rf /Users/$(whoami)/Library/Caches/jan*
```
4. Use the following commands to remove any dangling backend processes:
```sh
ps aux | grep nitro
```
Look for processes like "nitro" and "nitro_arm_64," and kill them one by one with:
```sh
kill -9 <PID>
```
## FAQs

View File

@ -10,7 +10,7 @@ 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.
![Jan Installer](../img/jan-download.png) ![Jan Installer](/img/jan-download.png)
## 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.
![Accept Jan](../img/window-defender.png) ![Accept Jan](/img/window-defender.png)
1. Wait for the 👋Jan.ai installation to complete. 1. Wait for the 👋Jan.ai installation to complete.
![Setting up](../img/set-up.png) ![Setting up](/img/set-up.png)
:::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.
![Explore models](../img/explore-model.png) ![Explore models](/img/explore-model.png)
1. 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."
![Model versions](../img/model-version.png) ![Model versions](/img/model-version.png)
> Note: Choose a model that matches your computer's memory and RAM. > Note: Choose a model that matches your computer's memory and RAM.
1. Select your preferred model and click "Download." 1. Select your preferred model and click "Download."
![Downloading](../img/downloading.png) ![Downloading](/img/downloading.png)
## 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."
![Start model](../img/start-model.png) ![Start model](/img/start-model.png)
## 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.
![Chat](../img/chat.png) ![Chat](/img/chat.png)
That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai. That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai.

View File

@ -0,0 +1,3 @@
---
title: How Jan Works
---

View File

@ -0,0 +1,5 @@
---
title: Architecture
---
- [ ] Add Architecture Diagram here

View File

@ -1,5 +1,5 @@
--- ---
title: "Chats" title: Chats
--- ---
:::warning :::warning

View File

@ -1,5 +1,5 @@
--- ---
title: "Messages" title: Messages
--- ---
:::warning :::warning

View File

@ -1,5 +1,5 @@
--- ---
title: "Models" title: Models
--- ---
:::warning :::warning

View File

@ -1,5 +1,5 @@
--- ---
title: "Threads" title: Threads
--- ---
:::warning :::warning

View File

@ -18,7 +18,7 @@ To Link:
## Views ## Views
![Jan Views](./img/jan-views.png) ![Jan Views](/img/jan-views.png)
TODO: add a better image. TODO: add a better image.
### Ribbon ### Ribbon

View File

@ -13,64 +13,61 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = { const sidebars = {
featuresSidebar: [
{
type: "category",
label: "Features",
collapsible: true,
collapsed: false,
link: { type: "doc", id: "features/features" },
items: [
"features/ai-models",
"features/control",
"features/acceleration",
"features/extensions",
],
},
],
docsSidebar: [ docsSidebar: [
{ {
type: "category", type: "category",
label: "Getting Started", label: "Introduction",
collapsible: false, link: { type: "doc", id: "intro/introduction" },
collapsible: true,
collapsed: false,
items: ["intro/quickstart", "intro/how-jan-works"],
},
{
type: "category",
label: "Installation",
collapsible: true,
collapsed: false,
items: ["install/windows", "install/mac", "install/linux"],
},
{
type: "category",
label: "Using Jan",
collapsible: true,
collapsed: false,
items: ["guide/models"],
},
{
type: "category",
label: "Extending Jan",
collapsible: true,
collapsed: false, collapsed: false,
items: [ items: [
"docs/introduction", "guide/assistants",
{ "guide/themes",
type: "category", "guide/tools",
label: "Installation", "guide/modules",
collapsible: true,
collapsed: true,
items: [
{
type: "autogenerated",
dirName: "getting-started/install",
},
],
},
"docs/quickstart",
], ],
}, },
{ {
type: "category", type: "category",
label: "Building Jan", label: "Building Jan",
collapsible: false, collapsible: true,
collapsed: false, collapsed: false,
items: [ items: [
"docs/user-interface", "specs/architecture",
{ {
type: "category", type: "category",
label: "Specifications", label: "Specifications",
collapsible: true, collapsible: true,
collapsed: true, collapsed: false,
items: [ items: [
"docs/specs/chats", "specs/user-interface",
"docs/specs/models", "specs/chats",
"docs/specs/threads", "specs/models",
"docs/specs/messages", "specs/threads",
"docs/specs/assistants", "specs/messages",
"docs/specs/files", "specs/assistants",
"specs/files",
], ],
}, },
], ],

View File

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

View File

Before

Width:  |  Height:  |  Size: 86 KiB

After

Width:  |  Height:  |  Size: 86 KiB

View File

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

View File

Before

Width:  |  Height:  |  Size: 186 KiB

After

Width:  |  Height:  |  Size: 186 KiB

View File

Before

Width:  |  Height:  |  Size: 128 KiB

After

Width:  |  Height:  |  Size: 128 KiB

View File

Before

Width:  |  Height:  |  Size: 62 KiB

After

Width:  |  Height:  |  Size: 62 KiB

View File

Before

Width:  |  Height:  |  Size: 85 KiB

After

Width:  |  Height:  |  Size: 85 KiB

View File

Before

Width:  |  Height:  |  Size: 5.6 KiB

After

Width:  |  Height:  |  Size: 5.6 KiB

View File

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 54 KiB

View File

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB