Merge branch 'main' into docs/openai-api

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)
 

docs/docs/features/acceleration.md

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

docs/docs/features/ai-models.md

@@ -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

docs/docs/features/control.md

@@ -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

docs/docs/features/extensions.md

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

docs/docs/features/features.md

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

docs/docs/features/unlimited.md

@@ -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

docs/docs/getting-started/troubleshooting.md

@@ -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>
-    ```
-    

docs/docs/guide/assistants.md

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

docs/docs/guide/models.md

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

docs/docs/guide/modules.md

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

docs/docs/guide/server.md

@@ -0,0 +1,3 @@
+---
+title: API Server
+---

docs/docs/guide/themes.md

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

docs/docs/guide/tools.md

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

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.
 

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

docs/docs/install/windows.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: 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.
 
-![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.

docs/docs/intro/how-jan-works.md

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

docs/docs/specs/architecture.md

@@ -1,8 +1,9 @@
 ---
-title: "Architecture and Concepts"
+title: Architecture
 ---
 
 ## Concepts
+
 ```mermaid
 graph LR
     A1[("A User Integrators")] -->|uses| B1[assistant]

docs/docs/specs/chats.md

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

docs/docs/specs/data-structures.md

@@ -0,0 +1,3 @@
+---
+title: Data Structures
+---

docs/docs/specs/jan.md

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

docs/docs/specs/messages.md

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

docs/docs/specs/models.md

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

docs/docs/specs/threads.md

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

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

docs/docusaurus.config.js

@@ -58,15 +58,13 @@ const config = {
     ],
   ],
 
-  // Only for react live
   themes: ["@docusaurus/theme-live-codeblock"],
 
   // The classic preset will relay each option entry to the respective sub plugin/theme.
   presets: [
     [
-      "classic",
-      /** @type {import('@docusaurus/preset-classic').Options} */
-      ({
+      "@docusaurus/preset-classic",
+      {
         // Will be passed to @docusaurus/plugin-content-docs (false to disable)
         docs: {
           routeBasePath: "/",
@@ -97,7 +95,7 @@ const config = {
         },
         // Will be passed to @docusaurus/plugin-content-pages (false to disable)
         // pages: {},
-      }),
+      },
     ],
     // Redoc preset
     [
@@ -119,59 +117,63 @@ const config = {
   ],
 
   // Docs: https://docusaurus.io/docs/api/themes/configuration
-  themeConfig:
-    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
-    ({
-      image: "img/jan-social-card.png",
-      // Only for react live
-      liveCodeBlock: {
-        playgroundPosition: "bottom",
+  themeConfig: {
+    image: "img/jan-social-card.png",
+    // Only for react live
+    liveCodeBlock: {
+      playgroundPosition: "bottom",
+    },
+    docs: {
+      sidebar: {
+        hideable: true,
+        autoCollapseCategories: true,
       },
-      navbar: {
-        title: "Jan",
-        logo: {
-          alt: "Jan Logo",
-          src: "img/logo.svg",
+    },
+    navbar: {
+      title: "Jan",
+      logo: {
+        alt: "Jan Logo",
+        src: "img/logo.svg",
+      },
+      items: [
+        // Navbar Left
+        {
+          type: "docSidebar",
+          sidebarId: "docsSidebar",
+          position: "left",
+          label: "Documentation",
         },
-        items: [
-          // Navbar Left
-          {
-            type: "docSidebar",
-            sidebarId: "docsSidebar",
-            position: "left",
-            label: "Documentation",
-          },
-          {
-            type: "docSidebar",
-            sidebarId: "apiSidebar",
-            position: "left",
-            label: "API Reference",
-          },
-          // Navbar right
-          {
-            to: "blog",
-            label: "Blog",
-            position: "right",
-          },
-          {
-            type: "docSidebar",
-            sidebarId: "aboutSidebar",
-            position: "right",
-            label: "About",
-          },
-        ],
-      },
-      prism: {
-        theme: darkCodeTheme,
-        darkTheme: darkCodeTheme,
-        additionalLanguages: ["python"],
-      },
-      colorMode: {
-        defaultMode: "dark",
-        disableSwitch: false,
-        respectPrefersColorScheme: false,
-      },
-    }),
+        {
+          type: "docSidebar",
+          sidebarId: "apiSidebar",
+          position: "left",
+          label: "API Reference",
+        },
+        // Navbar right
+        {
+          to: "blog",
+          label: "Blog",
+          position: "right",
+        },
+        {
+          type: "docSidebar",
+          sidebarId: "aboutSidebar",
+          position: "right",
+          label: "About",
+        },
+      ],
+    },
+    prism: {
+      theme: darkCodeTheme,
+      darkTheme: darkCodeTheme,
+      additionalLanguages: ["python"],
+    },
+    colorMode: {
+      defaultMode: "dark",
+      disableSwitch: false,
+      respectPrefersColorScheme: false,
+    },
+  },
 };
 
 module.exports = config;

docs/package.json

@@ -17,7 +17,7 @@
     "@docusaurus/core": "^2.4.3",
     "@docusaurus/preset-classic": "^2.4.3",
     "@docusaurus/theme-live-codeblock": "^2.4.3",
-    "@docusaurus/theme-mermaid": "^3.0.0",
+    "@docusaurus/theme-mermaid": "^2.4.3",
     "@headlessui/react": "^1.7.17",
     "@heroicons/react": "^2.0.18",
     "@mdx-js/react": "^1.6.22",

docs/sidebars.js

@@ -13,64 +13,64 @@
 
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 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: [
     {
       type: "category",
-      label: "Getting Started",
-      collapsible: false,
+      label: "Introduction",
+      link: { type: "doc", id: "intro/introduction" },
+      collapsible: true,
       collapsed: false,
+      items: ["intro/quickstart", "intro/how-jan-works"],
+    },
+    {
+      type: "category",
+      label: "Installation",
+      collapsible: true,
+      collapsed: true,
+      items: ["install/windows", "install/mac", "install/linux"],
+    },
+    {
+      type: "category",
+      label: "Using Jan",
+      collapsible: true,
+      collapsed: true,
+      items: ["guide/models", "guide/server"],
+    },
+    {
+      type: "category",
+      label: "Extending Jan",
+      collapsible: true,
+      collapsed: true,
       items: [
-        "docs/introduction",
-        {
-          type: "category",
-          label: "Installation",
-          collapsible: true,
-          collapsed: true,
-          items: [
-            {
-              type: "autogenerated",
-              dirName: "getting-started/install",
-            },
-          ],
-        },
-        "docs/quickstart",
+        "guide/assistants",
+        "guide/themes",
+        "guide/tools",
+        "guide/modules",
       ],
     },
     {
       type: "category",
       label: "Building Jan",
-      collapsible: false,
-      collapsed: false,
+      collapsible: true,
+      collapsed: true,
       items: [
-        "docs/user-interface",
+        "specs/architecture",
+        "specs/data-structures",
+        "specs/user-interface",
         {
           type: "category",
           label: "Specifications",
           collapsible: true,
-          collapsed: true,
+          collapsed: false,
           items: [
-            "docs/specs/chats",
-            "docs/specs/models",
-            "docs/specs/threads",
-            "docs/specs/messages",
-            "docs/specs/assistants",
-            "docs/specs/files",
+            "specs/chats",
+            "specs/models",
+            "specs/threads",
+            "specs/messages",
+            "specs/assistants",
+            "specs/files",
+            "specs/jan",
+            "specs/fine-tuning",
           ],
         },
       ],