Merge pull request #536 from janhq/structure-docs

Structure Docs

docs/docs/about/about.md

@@ -0,0 +1,6 @@
+---
+title: About Jan
+---
+
+- Mission, Vision, etc
+- COSS Model

docs/docs/developers/apps/app-anatomy.md

@@ -1,5 +1,4 @@
 ---
-sidebar_position: 2
 title: Anatomy of 👋Jan
 ---
 
@@ -7,7 +6,7 @@ This page explains all the architecture of [Jan](https://Jan/).
 
 ## Synchronous architecture
 
-![Synchronous architecture](img/arch-sync.drawio.png)
+![Synchronous architecture](../img/arch-async.drawio.png)
 
 ### Overview
 
@@ -60,7 +59,7 @@ With **Plugins and Apps**, users can build a broader ecosystem surrounding Jan.
 
 ## Asynchronous architecture
 
-![Asynchronous architecture](img/arch-async.drawio.png)
+![Asynchronous architecture](../img/arch-async.drawio.png)
 
 ### Overview
 
@@ -97,7 +96,7 @@ These are modular components or extensions designed to enhance the application's
 
 ## Jan workflow
 
-![Workflow](img/arch-flow.drawio.png)
+![Workflow](../img/arch-flow.drawio.png)
 
 ### Overview
 
@@ -163,7 +162,7 @@ This represents applications or extensions that can be integrated with Jan.
 
 ## Jan Platform
 
-![Platform](img/arch-connection.drawio.png)
+![Platform](../img/arch-connection.drawio.png)
 
 ### Overview
 

docs/docs/developers/apps/build-an-app.md

@@ -1,5 +1,4 @@
 ---
-sidebar_position: 2
 title: Build an app
 ---
 
@@ -145,7 +144,7 @@ module.exports = {
 
 ## App installation
 
-![Manual installation](img/build-app-1.png)
+![Manual installation](../img/build-app-1.png)
 
 - `Select` the built `*.tar.gz` file
 - Jan will reload after new apps get installed

docs/docs/developers/apps/publish-jan-app.md

@@ -1,5 +1,4 @@
 ---
-sidebar_position: 3
 title: Publishing an app
 ---
 

docs/docs/developers/developers.md

@@ -1,5 +1,4 @@
 ---
-sidebar_position: 1
 title: Overview
 ---
 Jan's mission is to power the next-gen App with limitless extensibility by providing users with the following:

docs/docs/guides/install/cloud-native.md

@@ -1,8 +1,9 @@
 ---
-sidebar_position: 5
 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.
 
 > This is an experimental feature - expect breaking changes!
@@ -35,7 +36,7 @@ Open your browser at [http://localhost:4000](http://localhost:4000)
 
 ### Architecture
 
-![cloudnative](img/cloudnative.png)
+![cloudnative](../../developers/img/cloudnative.png)
 
 ### TODOs
 

docs/docs/guides/install/install.md

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

docs/docs/guides/install/linux.md

@@ -1,16 +1,18 @@
 ---
-title: Installing Jan on Linux
-sidebar_position: 4
+title: Linux
 ---
 
-# Linux users
-## Step 1: Download the Installer
+# Installing Jan on Linux
+
+## Installation
+
+### Step 1: Download the Installer
 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
 
@@ -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:
 
 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.
 
-![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
+### 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
+
+### Step 4: Start the conversations
 Now you're ready to start using 👋Jan.ai for conversations:
 
 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.
+That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai.
+
+## Uninstallation
+
+## Troubleshooting

docs/docs/guides/install/mac.md

@@ -1,48 +1,52 @@
 ---
-title: Installing Jan on Mac
-sidebar_position: 2
+title: Mac 
 ---
 
-# Mac users
-## Step 1: Download the Installer
+## Installation
+
+### Step 1: Download the Installer
 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
+### Step 2: Download 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.
 
 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
+### 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
+### Step 4: Start the conversations
 Now you're ready to start using 👋Jan.ai for conversations:
 
 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.
+That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai.
+
+## Uninstallation
+
+## Troubleshooting

docs/docs/guides/install/windows.md

@@ -1,16 +1,16 @@
 ---
-title: Installing Jan on Windows
-sidebar_position: 3
+title: Windows
 ---
 
-# Windows users
+# Installing Jan on Windows
+
 ## Step 1: Download the Installer
 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)
 
-2. 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
 
@@ -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)
 
-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."
 
-![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."
+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/guides/overview.md

@@ -1,6 +1,6 @@
 ---
-title: Concepts
-sidebar_position: 1
+title: Overview
+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 App: Next-gen App built on Jan Plaform as `portable intelligence` that can be run everywhere.

docs/docs/handbook/engineering/engineering.md

@@ -1,10 +1,7 @@
 ---
-title: Internal Guidelines
-sidebar_position: 6
+title: Engineering
 ---
 
-# Internal Guidelines
-
 ## Connecting to Rigs
 
 ### Pritunl Setup

docs/docs/handbook/handbook.md

@@ -1,4 +1,7 @@
 ---
 title: Company Handbook
 slug: /handbook
----
+---
+
+
+## Remote Work

docs/docs/handbook/remote-work.md

@@ -1,3 +0,0 @@
----
-title: How We Work
----

docs/docs/nitro/nitro.md

@@ -1,6 +1,6 @@
 ---
-sidebar_position: 4
-title: Nitro (C++ Inference Engine)
+title: Nitro 
+slug: /nitro
 ---
 
 Nitro, is the inference engine that powers Jan. Nitro is written in C++, optimized for edge deployment.
@@ -73,4 +73,4 @@ curl -X POST 'http://localhost:3928/inferences/llamacpp/loadmodel' \
 
 ## Architecture diagram
 
-![Nitro Architecture](img/architecture.png)
+![Nitro Architecture](../developers/img/architecture.png)

docs/docusaurus.config.js

@@ -118,30 +118,24 @@ const config = {
         },
         items: [
           // Navbar left
-          // {
-          //   type: "docSidebar",
-          //   sidebarId: "featuresSidebar",
-          //   position: "left",
-          //   label: "Platform",
-          // },
-          {
-            type: "docSidebar",
-            sidebarId: "companySidebar",
-            position: "left",
-            label: "Company",
-          },
-          // Navbar right
           {
             type: "docSidebar",
             sidebarId: "guidesSidebar",
-            position: "right",
-            label: "User Guides",
+            position: "left",
+            label: "User Guide",
           },
           {
             type: "docSidebar",
             sidebarId: "devSidebar",
+            position: "left",
+            label: "Developers",
+          },
+          // Navbar right
+          {
+            type: "docSidebar",
+            sidebarId: "aboutSidebar",
             position: "right",
-            label: "Developer",
+            label: "About",
           },
         ],
       },

docs/sidebars.js

@@ -29,41 +29,56 @@ const sidebars = {
     },
   ],
 
-  // Autogenerate docs from /guides
   guidesSidebar: [
+    "guides/overview",
     {
       type: "category",
-      label: "Guides",
+      label: "Installation",
+      collapsible: true,
+      collapsed: true,
+      link: { type: "doc", id: "guides/install/install" },
+      items: [
+        "guides/install/linux",
+        "guides/install/windows",
+        "guides/install/mac",
+        "guides/install/cloud-native",
+      ],
+    },
+    "guides/troubleshooting",
+  ],
+
+  devSidebar: [
+    "developers/developers",
+    "nitro/nitro",
+    {
+      type: "category",
+      label: "Apps",
       collapsible: true,
       collapsed: true,
       items: [
         {
           type: "autogenerated",
-          dirName: "guides",
+          dirName: "developers/apps",
         },
       ],
     },
-  ],
-
-  //
-  devSidebar: [
     {
       type: "category",
-      label: "Getting Started",
+      label: "Plugins",
       collapsible: true,
-      collapsed: false,
+      collapsed: true,
       items: [
         {
           type: "autogenerated",
-          dirName: "getting-started",
+          dirName: "developers/plugins",
         },
       ],
     },
     {
       type: "category",
-      label: "Reference",
+      label: "API Reference",
       collapsible: true,
-      collapsed: false,
+      collapsed: true,
       items: [
         {
           type: "autogenerated",
@@ -71,61 +86,19 @@ const sidebars = {
         },
       ],
     },
-    {
-      type: "category",
-      label: "Apps (Plugins)",
-      collapsible: true,
-      collapsed: true,
-      items: [
-        {
-          type: "autogenerated",
-          dirName: "apps",
-        },
-      ],
-    },
-    // {
-    //   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",
-    //     },
-    //   ],
-    // },
   ],
 
-  companySidebar: [
-    // {
-    //   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",
-    //     },
-    //   ],
-    // },
+  aboutSidebar: [
+    {
+      type: "doc",
+      label: "About Jan",
+      id: "about/about",
+    },
+    {
+      type: "link",
+      label: "Careers",
+      href: "https://janai.bamboohr.com/careers",
+    },
     {
       type: "category",
       label: "Events",
@@ -139,14 +112,20 @@ const sidebars = {
         },
       ],
     },
-    // {
-    //   type: "category",
-    //   label: "Company Handbook",
-    //   collapsible: true,
-    //   collapsed: true,
-    //   link: { type: "doc", id: "handbook/handbook" },
-    //   items: ["handbook/remote-work"],
-    // },
+    {
+      type: "category",
+      label: "Company Handbook",
+      collapsible: true,
+      collapsed: true,
+      link: { type: "doc", id: "handbook/handbook" },
+      items: [
+        {
+          type: "doc",
+          label: "Engineering",
+          id: "handbook/engineering/engineering",
+        },
+      ],
+    },
   ],
 };