Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Preliminary Restructure of Docs #655

Merged
merged 6 commits into from
Nov 19, 2023
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
4 changes: 2 additions & 2 deletions docs/docs/events/nvidia-llm-day-nov-23.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 3,7 @@ title: "Nov 23: Nvidia GenAI Day"
description: Nvidia's LLM Day
---

![](../../static/img/nvidia-llm-day-header.png)
![](/img/nvidia-llm-day-header.png)

## Nvidia GenAI Innovation Day

Expand All @@ -17,5 17,5 @@ Jan will be at Nvidia's GenAI Innovation Day in Nov '23, focusing on Enterprise

### Programme

![](../../static/img/nvidia-llm-day.png)
![](/img/nvidia-llm-day.png)

3 changes: 0 additions & 3 deletions docs/docs/features/acceleration.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/docs/features/ai-models.md

This file was deleted.

12 changes: 0 additions & 12 deletions docs/docs/features/control.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/docs/features/extensions.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/docs/features/features.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/docs/features/unlimited.md

This file was deleted.

42 changes: 0 additions & 42 deletions docs/docs/getting-started/troubleshooting.md

This file was deleted.

3 changes: 3 additions & 0 deletions docs/docs/guide/assistants.md
Original file line number Diff line number Diff line change
@@ -0,0 1,3 @@
---
title: Build an Assistant
---
3 changes: 3 additions & 0 deletions docs/docs/guide/models.md
Original file line number Diff line number Diff line change
@@ -0,0 1,3 @@
---
title: Model Management
---
3 changes: 3 additions & 0 deletions docs/docs/guide/modules.md
Original file line number Diff line number Diff line change
@@ -0,0 1,3 @@
---
title: Build a Module
---
3 changes: 3 additions & 0 deletions docs/docs/guide/server.md
Original file line number Diff line number Diff line change
@@ -0,0 1,3 @@
---
title: API Server
---
3 changes: 3 additions & 0 deletions docs/docs/guide/themes.md
Original file line number Diff line number Diff line change
@@ -0,0 1,3 @@
---
title: Build a Theme
---
3 changes: 3 additions & 0 deletions docs/docs/guide/tools.md
Original file line number Diff line number Diff line change
@@ -0,0 1,3 @@
---
title: Build a Tool
---
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 12,7 @@ To begin using 👋Jan.ai on your Windows computer, follow these steps:
1. Visit [Jan.ai](https://jan.ai/).
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

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

![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."

![Model versions](../img/model-version.png)
![Model versions](/img/model-version.png)

> Note: Choose a model that matches your computer's memory and RAM.

4. Select your preferred model and click "Download."

![Downloading](../img/downloading.png)
![Downloading](/img/downloading.png)

### Step 3: Start the 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
Expand All @@ -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.

![Chat](../img/chat.png)
![Chat](/img/chat.png)

That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 10,7 @@ To begin using 👋Jan.ai on your Windows computer, follow these steps:
1. Visit [Jan.ai](https://jan.ai/).
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
Now, let's get your first model:
Expand All @@ -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.

![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."

![Model versions](../img/model-version.png)
![Model versions](/img/model-version.png)

> Note: Choose a model that matches your computer's memory and RAM.

4. Select your preferred model and click "Download."

![Downloading](../img/downloading.png)
![Downloading](/img/downloading.png)

### Step 3: Start the 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
Now you're ready to start using 👋Jan.ai for conversations:
Expand All @@ -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.

![Chat](../img/chat.png)
![Chat](/img/chat.png)

That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai.

## 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
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 10,19 @@ To begin using 👋Jan.ai on your Windows computer, follow these steps:
1. Visit [Jan.ai](https://jan.ai/).
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

When you run the Jan Installer, Windows Defender may display a warning. Here's what to do:

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.

![Setting up](../img/set-up.png)
![Setting up](/img/set-up.png)

:::tip

Expand All @@ -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.

![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."

![Model versions](../img/model-version.png)
![Model versions](/img/model-version.png)

> Note: Choose a model that matches your computer's memory and RAM.

1. Select your preferred model and click "Download."

![Downloading](../img/downloading.png)
![Downloading](/img/downloading.png)

## Step 4: Start the 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
Now you're ready to start using 👋Jan.ai for conversations:
Expand All @@ -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.

![Chat](../img/chat.png)
![Chat](/img/chat.png)

That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai.
3 changes: 3 additions & 0 deletions docs/docs/intro/how-jan-works.md
Original file line number Diff line number Diff line change
@@ -0,0 1,3 @@
---
title: How Jan Works
---
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,8 1,9 @@
---
title: "Architecture and Concepts"
title: Architecture
---

## Concepts

```mermaid
graph LR
A1[("A User Integrators")] -->|uses| B1[assistant]
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/docs/docs/specs/chats.md → docs/docs/specs/chats.md
Original file line number Diff line number Diff line change
@@ -1,5 1,5 @@
---
title: "Chats"
title: Chats
---

:::warning
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/specs/data-structures.md
Original file line number Diff line number Diff line change
@@ -0,0 1,3 @@
---
title: Data Structures
---
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/docs/specs/jan.md
Original file line number Diff line number Diff line change
@@ -0,0 1,3 @@
---
title: Jan
---
Original file line number Diff line number Diff line change
@@ -1,5 1,5 @@
---
title: "Messages"
title: Messages
---

:::warning
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 1,5 @@
---
title: "Models"
title: Models
---

:::warning
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 1,5 @@
---
title: "Threads"
title: Threads
---

:::warning
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 18,7 @@ To Link:

## Views

![Jan Views](./img/jan-views.png)
![Jan Views](/img/jan-views.png)
TODO: add a better image.

### Ribbon
Expand Down
Loading