Restructure Documentation section

mvdt · Nov 18, 2023 · 54225a3 · 54225a3
1 parent afb63b7
commit 54225a3
Show file tree

Hide file tree

Showing 38 changed files with 117 additions and 152 deletions.
diff --git a/docs/docs/events/nvidia-llm-day-nov-23.md b/docs/docs/events/nvidia-llm-day-nov-23.md
@@ -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
 
@@ -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)
 
diff --git a/docs/docs/features/acceleration.md b/docs/docs/features/acceleration.md
diff --git a/docs/docs/features/ai-models.md b/docs/docs/features/ai-models.md
diff --git a/docs/docs/features/control.md b/docs/docs/features/control.md
diff --git a/docs/docs/features/extensions.md b/docs/docs/features/extensions.md
diff --git a/docs/docs/features/features.md b/docs/docs/features/features.md
diff --git a/docs/docs/features/unlimited.md b/docs/docs/features/unlimited.md
diff --git a/docs/docs/getting-started/troubleshooting.md b/docs/docs/getting-started/troubleshooting.md
diff --git a/docs/docs/guide/assistants.md b/docs/docs/guide/assistants.md
@@ -0,0 +1,3 @@
+---
+title: Build an Assistant
+---
diff --git a/docs/docs/guide/models.md b/docs/docs/guide/models.md
@@ -0,0 +1,3 @@
+---
+title: Model Management
+---
diff --git a/docs/docs/guide/modules.md b/docs/docs/guide/modules.md
@@ -0,0 +1,3 @@
+---
+title: Build a Module
+---
diff --git a/docs/docs/guide/themes.md b/docs/docs/guide/themes.md
@@ -0,0 +1,3 @@
+---
+title: Build a Theme
+---
diff --git a/docs/docs/guide/tools.md b/docs/docs/guide/tools.md
@@ -0,0 +1,3 @@
+---
+title: Build a Tool
+---
diff --git a/docs/docs/getting-started/install/linux.md → docs/docs/install/linux.md b/docs/docs/getting-started/install/linux.md → docs/docs/install/linux.md
@@ -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
 
@@ -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
@@ -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.
 

diff --git a/docs/docs/getting-started/install/mac.md → docs/docs/install/mac.md b/docs/docs/getting-started/install/mac.md → docs/docs/install/mac.md
@@ -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:
@@ -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:
@@ -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
diff --git a/docs/docs/getting-started/install/windows.md → docs/docs/install/windows.md b/docs/docs/getting-started/install/windows.md → docs/docs/install/windows.md
@@ -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
 
@@ -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:
@@ -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.
diff --git a/docs/docs/intro/how-jan-works.md b/docs/docs/intro/how-jan-works.md
@@ -0,0 +1,3 @@
+---
+title: How Jan Works
+---
diff --git a/docs/docs/docs/01_introduction.md → docs/docs/intro/introduction.md b/docs/docs/docs/01_introduction.md → docs/docs/intro/introduction.md
diff --git a/docs/docs/docs/02_quickstart.md → docs/docs/intro/quickstart.md b/docs/docs/docs/02_quickstart.md → docs/docs/intro/quickstart.md
diff --git a/docs/docs/specs/architecture.md b/docs/docs/specs/architecture.md
@@ -0,0 +1,5 @@
+---
+title: Architecture
+---
+
+- [ ] Add Architecture Diagram here
diff --git a/docs/docs/docs/specs/assistants.md → docs/docs/specs/assistants.md b/docs/docs/docs/specs/assistants.md → docs/docs/specs/assistants.md
diff --git a/docs/docs/docs/specs/chats.md → docs/docs/specs/chats.md b/docs/docs/docs/specs/chats.md → docs/docs/specs/chats.md
@@ -1,5 +1,5 @@
 ---
-title: "Chats"
+title: Chats
 ---
 
 :::warning

diff --git a/docs/docs/docs/specs/files.md → docs/docs/specs/files.md b/docs/docs/docs/specs/files.md → docs/docs/specs/files.md
diff --git a/docs/docs/docs/specs/messages.md → docs/docs/specs/messages.md b/docs/docs/docs/specs/messages.md → docs/docs/specs/messages.md
@@ -1,5 +1,5 @@
 ---
-title: "Messages"
+title: Messages
 ---
 
 :::warning

diff --git a/docs/docs/docs/specs/models.md → docs/docs/specs/models.md b/docs/docs/docs/specs/models.md → docs/docs/specs/models.md
@@ -1,5 +1,5 @@
 ---
-title: "Models"
+title: Models
 ---
 
 :::warning

diff --git a/docs/docs/docs/specs/threads.md → docs/docs/specs/threads.md b/docs/docs/docs/specs/threads.md → docs/docs/specs/threads.md
@@ -1,5 +1,5 @@
 ---
-title: "Threads"
+title: Threads
 ---
 
 :::warning

diff --git a/docs/docs/docs/user-interface.md → docs/docs/specs/user-interface.md b/docs/docs/docs/user-interface.md → docs/docs/specs/user-interface.md
@@ -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