From ce37261133caf7470b5698d8ae2e02f7af477f7b Mon Sep 17 00:00:00 2001 From: Daniel <101145494+dan-jan@users.noreply.github.com> Date: Sat, 4 Nov 2023 09:08:01 +0700 Subject: [PATCH 1/3] Initial refactor of About section --- docs/docs/about/about.md | 6 ++++ .../engineering}/internal.md | 3 +- docs/docs/handbook/handbook.md | 5 +++- docs/docs/handbook/remote-work.md | 3 -- docs/docusaurus.config.js | 24 ++++++---------- docs/sidebars.js | 28 +++++++++++++------ 6 files changed, 39 insertions(+), 30 deletions(-) create mode 100644 docs/docs/about/about.md rename docs/docs/{guides => handbook/engineering}/internal.md (99%) delete mode 100644 docs/docs/handbook/remote-work.md diff --git a/docs/docs/about/about.md b/docs/docs/about/about.md new file mode 100644 index 000000000..9d813e021 --- /dev/null +++ b/docs/docs/about/about.md @@ -0,0 +1,6 @@ +--- +title: About Jan +--- + +- Mission, Vision, etc +- COSS Model \ No newline at end of file diff --git a/docs/docs/guides/internal.md b/docs/docs/handbook/engineering/internal.md similarity index 99% rename from docs/docs/guides/internal.md rename to docs/docs/handbook/engineering/internal.md index 20579556a..6d911671f 100644 --- a/docs/docs/guides/internal.md +++ b/docs/docs/handbook/engineering/internal.md @@ -1,6 +1,5 @@ --- -title: Internal Guidelines -sidebar_position: 6 +title: Cookbook --- # Internal Guidelines diff --git a/docs/docs/handbook/handbook.md b/docs/docs/handbook/handbook.md index bfb919b92..3cb2c1af9 100644 --- a/docs/docs/handbook/handbook.md +++ b/docs/docs/handbook/handbook.md @@ -1,4 +1,7 @@ --- title: Company Handbook slug: /handbook ---- \ No newline at end of file +--- + + +## Remote Work \ No newline at end of file diff --git a/docs/docs/handbook/remote-work.md b/docs/docs/handbook/remote-work.md deleted file mode 100644 index b943e293c..000000000 --- a/docs/docs/handbook/remote-work.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: How We Work ---- \ No newline at end of file diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index f9f0eb6dc..d108908c1 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -118,31 +118,25 @@ 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", + position: "left", label: "User Guides", }, { type: "docSidebar", sidebarId: "devSidebar", - position: "right", + position: "left", label: "Developer", }, + // Navbar right + { + type: "docSidebar", + sidebarId: "aboutSidebar", + position: "right", + label: "About", + }, ], }, prism: { diff --git a/docs/sidebars.js b/docs/sidebars.js index cd5f7721b..a260dfee0 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -110,7 +110,7 @@ const sidebars = { // }, ], - companySidebar: [ + aboutSidebar: [ // { // type: "category", // label: "About Jan", @@ -126,6 +126,10 @@ const sidebars = { // }, // ], // }, + { + type: "doc", + id: "about/about", + }, { type: "category", label: "Events", @@ -139,14 +143,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: "category", + label: "Engineering", + items: ["handbook/engineering/internal"], + }, + ], + }, ], }; From 663016de582707435368214ec32971f480d66dc8 Mon Sep 17 00:00:00 2001 From: Daniel <101145494+dan-jan@users.noreply.github.com> Date: Sat, 4 Nov 2023 14:50:42 +0700 Subject: [PATCH 2/3] Refactor structure for User Guide --- .../install}/cloud-native.md | 5 +- docs/docs/guides/install/install.md | 3 + docs/docs/guides/{ => install}/linux.md | 35 ++++++---- docs/docs/guides/{ => install}/mac.md | 32 +++++---- docs/docs/guides/{ => install}/windows.md | 28 ++++---- docs/docs/guides/{concepts.md => overview.md} | 4 +- .../{internal.md => engineering.md} | 4 +- docs/docusaurus.config.js | 4 +- docs/sidebars.js | 65 +++++-------------- 9 files changed, 80 insertions(+), 100 deletions(-) rename docs/docs/{getting-started => guides/install}/cloud-native.md (91%) create mode 100644 docs/docs/guides/install/install.md rename docs/docs/guides/{ => install}/linux.md (76%) rename docs/docs/guides/{ => install}/mac.md (68%) rename docs/docs/guides/{ => install}/windows.md (77%) rename docs/docs/guides/{concepts.md => overview.md} (91%) rename docs/docs/handbook/engineering/{internal.md => engineering.md} (99%) diff --git a/docs/docs/getting-started/cloud-native.md b/docs/docs/guides/install/cloud-native.md similarity index 91% rename from docs/docs/getting-started/cloud-native.md rename to docs/docs/guides/install/cloud-native.md index 7db615dfe..773415d22 100644 --- a/docs/docs/getting-started/cloud-native.md +++ b/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](../../getting-started/img/cloudnative.png) ### TODOs diff --git a/docs/docs/guides/install/install.md b/docs/docs/guides/install/install.md new file mode 100644 index 000000000..5bc823348 --- /dev/null +++ b/docs/docs/guides/install/install.md @@ -0,0 +1,3 @@ +--- +title: Installation +--- \ No newline at end of file diff --git a/docs/docs/guides/linux.md b/docs/docs/guides/install/linux.md similarity index 76% rename from docs/docs/guides/linux.md rename to docs/docs/guides/install/linux.md index 067c9f54e..34158cae2 100644 --- a/docs/docs/guides/linux.md +++ b/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. \ No newline at end of file +That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai. + +## Uninstallation + +## Troubleshooting \ No newline at end of file diff --git a/docs/docs/guides/mac.md b/docs/docs/guides/install/mac.md similarity index 68% rename from docs/docs/guides/mac.md rename to docs/docs/guides/install/mac.md index 13c8033ed..e3bbc353b 100644 --- a/docs/docs/guides/mac.md +++ b/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. \ No newline at end of file +That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai. + +## Uninstallation + +## Troubleshooting \ No newline at end of file diff --git a/docs/docs/guides/windows.md b/docs/docs/guides/install/windows.md similarity index 77% rename from docs/docs/guides/windows.md rename to docs/docs/guides/install/windows.md index d798f5682..6b13841e7 100644 --- a/docs/docs/guides/windows.md +++ b/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. \ No newline at end of file diff --git a/docs/docs/guides/concepts.md b/docs/docs/guides/overview.md similarity index 91% rename from docs/docs/guides/concepts.md rename to docs/docs/guides/overview.md index dc4508861..bf44ca685 100644 --- a/docs/docs/guides/concepts.md +++ b/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. diff --git a/docs/docs/handbook/engineering/internal.md b/docs/docs/handbook/engineering/engineering.md similarity index 99% rename from docs/docs/handbook/engineering/internal.md rename to docs/docs/handbook/engineering/engineering.md index 6d911671f..e320b25fe 100644 --- a/docs/docs/handbook/engineering/internal.md +++ b/docs/docs/handbook/engineering/engineering.md @@ -1,9 +1,7 @@ --- -title: Cookbook +title: Engineering --- -# Internal Guidelines - ## Connecting to Rigs ### Pritunl Setup diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index d108908c1..7de037430 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -122,13 +122,13 @@ const config = { type: "docSidebar", sidebarId: "guidesSidebar", position: "left", - label: "User Guides", + label: "User Guide", }, { type: "docSidebar", sidebarId: "devSidebar", position: "left", - label: "Developer", + label: "Developers", }, // Navbar right { diff --git a/docs/sidebars.js b/docs/sidebars.js index a260dfee0..13d9c10d6 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -29,23 +29,24 @@ 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: [ - { - type: "autogenerated", - dirName: "guides", - }, + "guides/install/linux", + "guides/install/windows", + "guides/install/mac", + "guides/install/cloud-native", ], }, + "guides/troubleshooting", ], - // devSidebar: [ { type: "category", @@ -83,53 +84,19 @@ const sidebars = { }, ], }, - // { - // 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", - // }, - // ], - // }, ], aboutSidebar: [ - // { - // 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", - // }, - // ], - // }, { type: "doc", + label: "About Jan", id: "about/about", }, + { + type: "link", + label: "Careers", + href: "https://janai.bamboohr.com/careers", + }, { type: "category", label: "Events", @@ -151,9 +118,9 @@ const sidebars = { link: { type: "doc", id: "handbook/handbook" }, items: [ { - type: "category", + type: "doc", label: "Engineering", - items: ["handbook/engineering/internal"], + id: "handbook/engineering/engineering", }, ], }, From bcf3afe9ddb86fd240f08dc4e303d1f980c192ba Mon Sep 17 00:00:00 2001 From: Daniel <101145494+dan-jan@users.noreply.github.com> Date: Sat, 4 Nov 2023 15:16:50 +0700 Subject: [PATCH 3/3] Refactor structure for Developers --- .../apps}/app-anatomy.md | 9 ++- .../apps}/build-an-app.md | 3 +- .../apps}/publish-jan-app.md | 1 - .../overview.md => developers/developers.md} | 1 - .../img/app-anatomy-1.drawio.jpg | Bin .../img/app-anatomy-2.drawio.jpg | Bin .../img/app-anatomy-3.drawio.jpg | Bin .../img/app-anatomy-4.drawio.jpg | Bin .../img/app-anatomy-5.drawio.png | Bin .../img/arch-async.drawio.png | Bin .../img/arch-connection.drawio.png | Bin .../img/arch-flow.drawio.png | Bin .../img/arch-sync.drawio.png | Bin .../img/architecture-0.drawio.png | Bin .../img/architecture-1.drawio.png | Bin .../img/architecture.png | Bin .../img/build-app-1.png | Bin .../img/cloudnative.png | Bin .../plugins}/azure-openai.md | 0 .../docs/{apps => developers/plugins}/data.md | 0 .../{apps => developers/plugins}/inference.md | 0 .../plugins}/model-management.md | 0 .../plugins}/monitoring.md | 0 docs/docs/{apps => developers/plugins}/rag.md | 0 docs/docs/guides/install/cloud-native.md | 2 +- docs/docs/{getting-started => nitro}/nitro.md | 6 +- docs/sidebars.js | 54 +++++++++--------- 27 files changed, 37 insertions(+), 39 deletions(-) rename docs/docs/{getting-started => developers/apps}/app-anatomy.md (97%) rename docs/docs/{getting-started => developers/apps}/build-an-app.md (98%) rename docs/docs/{getting-started => developers/apps}/publish-jan-app.md (97%) rename docs/docs/{getting-started/overview.md => developers/developers.md} (97%) rename docs/docs/{getting-started => developers}/img/app-anatomy-1.drawio.jpg (100%) rename docs/docs/{getting-started => developers}/img/app-anatomy-2.drawio.jpg (100%) rename docs/docs/{getting-started => developers}/img/app-anatomy-3.drawio.jpg (100%) rename docs/docs/{getting-started => developers}/img/app-anatomy-4.drawio.jpg (100%) rename docs/docs/{getting-started => developers}/img/app-anatomy-5.drawio.png (100%) rename docs/docs/{getting-started => developers}/img/arch-async.drawio.png (100%) rename docs/docs/{getting-started => developers}/img/arch-connection.drawio.png (100%) rename docs/docs/{getting-started => developers}/img/arch-flow.drawio.png (100%) rename docs/docs/{getting-started => developers}/img/arch-sync.drawio.png (100%) rename docs/docs/{getting-started => developers}/img/architecture-0.drawio.png (100%) rename docs/docs/{getting-started => developers}/img/architecture-1.drawio.png (100%) rename docs/docs/{getting-started => developers}/img/architecture.png (100%) rename docs/docs/{getting-started => developers}/img/build-app-1.png (100%) rename docs/docs/{getting-started => developers}/img/cloudnative.png (100%) rename docs/docs/{apps => developers/plugins}/azure-openai.md (100%) rename docs/docs/{apps => developers/plugins}/data.md (100%) rename docs/docs/{apps => developers/plugins}/inference.md (100%) rename docs/docs/{apps => developers/plugins}/model-management.md (100%) rename docs/docs/{apps => developers/plugins}/monitoring.md (100%) rename docs/docs/{apps => developers/plugins}/rag.md (100%) rename docs/docs/{getting-started => nitro}/nitro.md (95%) diff --git a/docs/docs/getting-started/app-anatomy.md b/docs/docs/developers/apps/app-anatomy.md similarity index 97% rename from docs/docs/getting-started/app-anatomy.md rename to docs/docs/developers/apps/app-anatomy.md index 6e939dec9..93b2d6ba8 100644 --- a/docs/docs/getting-started/app-anatomy.md +++ b/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 diff --git a/docs/docs/getting-started/build-an-app.md b/docs/docs/developers/apps/build-an-app.md similarity index 98% rename from docs/docs/getting-started/build-an-app.md rename to docs/docs/developers/apps/build-an-app.md index 578de7bb6..a71f51159 100644 --- a/docs/docs/getting-started/build-an-app.md +++ b/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 diff --git a/docs/docs/getting-started/publish-jan-app.md b/docs/docs/developers/apps/publish-jan-app.md similarity index 97% rename from docs/docs/getting-started/publish-jan-app.md rename to docs/docs/developers/apps/publish-jan-app.md index cc8fab010..dbdfbfd10 100644 --- a/docs/docs/getting-started/publish-jan-app.md +++ b/docs/docs/developers/apps/publish-jan-app.md @@ -1,5 +1,4 @@ --- -sidebar_position: 3 title: Publishing an app --- diff --git a/docs/docs/getting-started/overview.md b/docs/docs/developers/developers.md similarity index 97% rename from docs/docs/getting-started/overview.md rename to docs/docs/developers/developers.md index 3a3f07a68..b0ef47a8c 100644 --- a/docs/docs/getting-started/overview.md +++ b/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: diff --git a/docs/docs/getting-started/img/app-anatomy-1.drawio.jpg b/docs/docs/developers/img/app-anatomy-1.drawio.jpg similarity index 100% rename from docs/docs/getting-started/img/app-anatomy-1.drawio.jpg rename to docs/docs/developers/img/app-anatomy-1.drawio.jpg diff --git a/docs/docs/getting-started/img/app-anatomy-2.drawio.jpg b/docs/docs/developers/img/app-anatomy-2.drawio.jpg similarity index 100% rename from docs/docs/getting-started/img/app-anatomy-2.drawio.jpg rename to docs/docs/developers/img/app-anatomy-2.drawio.jpg diff --git a/docs/docs/getting-started/img/app-anatomy-3.drawio.jpg b/docs/docs/developers/img/app-anatomy-3.drawio.jpg similarity index 100% rename from docs/docs/getting-started/img/app-anatomy-3.drawio.jpg rename to docs/docs/developers/img/app-anatomy-3.drawio.jpg diff --git a/docs/docs/getting-started/img/app-anatomy-4.drawio.jpg b/docs/docs/developers/img/app-anatomy-4.drawio.jpg similarity index 100% rename from docs/docs/getting-started/img/app-anatomy-4.drawio.jpg rename to docs/docs/developers/img/app-anatomy-4.drawio.jpg diff --git a/docs/docs/getting-started/img/app-anatomy-5.drawio.png b/docs/docs/developers/img/app-anatomy-5.drawio.png similarity index 100% rename from docs/docs/getting-started/img/app-anatomy-5.drawio.png rename to docs/docs/developers/img/app-anatomy-5.drawio.png diff --git a/docs/docs/getting-started/img/arch-async.drawio.png b/docs/docs/developers/img/arch-async.drawio.png similarity index 100% rename from docs/docs/getting-started/img/arch-async.drawio.png rename to docs/docs/developers/img/arch-async.drawio.png diff --git a/docs/docs/getting-started/img/arch-connection.drawio.png b/docs/docs/developers/img/arch-connection.drawio.png similarity index 100% rename from docs/docs/getting-started/img/arch-connection.drawio.png rename to docs/docs/developers/img/arch-connection.drawio.png diff --git a/docs/docs/getting-started/img/arch-flow.drawio.png b/docs/docs/developers/img/arch-flow.drawio.png similarity index 100% rename from docs/docs/getting-started/img/arch-flow.drawio.png rename to docs/docs/developers/img/arch-flow.drawio.png diff --git a/docs/docs/getting-started/img/arch-sync.drawio.png b/docs/docs/developers/img/arch-sync.drawio.png similarity index 100% rename from docs/docs/getting-started/img/arch-sync.drawio.png rename to docs/docs/developers/img/arch-sync.drawio.png diff --git a/docs/docs/getting-started/img/architecture-0.drawio.png b/docs/docs/developers/img/architecture-0.drawio.png similarity index 100% rename from docs/docs/getting-started/img/architecture-0.drawio.png rename to docs/docs/developers/img/architecture-0.drawio.png diff --git a/docs/docs/getting-started/img/architecture-1.drawio.png b/docs/docs/developers/img/architecture-1.drawio.png similarity index 100% rename from docs/docs/getting-started/img/architecture-1.drawio.png rename to docs/docs/developers/img/architecture-1.drawio.png diff --git a/docs/docs/getting-started/img/architecture.png b/docs/docs/developers/img/architecture.png similarity index 100% rename from docs/docs/getting-started/img/architecture.png rename to docs/docs/developers/img/architecture.png diff --git a/docs/docs/getting-started/img/build-app-1.png b/docs/docs/developers/img/build-app-1.png similarity index 100% rename from docs/docs/getting-started/img/build-app-1.png rename to docs/docs/developers/img/build-app-1.png diff --git a/docs/docs/getting-started/img/cloudnative.png b/docs/docs/developers/img/cloudnative.png similarity index 100% rename from docs/docs/getting-started/img/cloudnative.png rename to docs/docs/developers/img/cloudnative.png diff --git a/docs/docs/apps/azure-openai.md b/docs/docs/developers/plugins/azure-openai.md similarity index 100% rename from docs/docs/apps/azure-openai.md rename to docs/docs/developers/plugins/azure-openai.md diff --git a/docs/docs/apps/data.md b/docs/docs/developers/plugins/data.md similarity index 100% rename from docs/docs/apps/data.md rename to docs/docs/developers/plugins/data.md diff --git a/docs/docs/apps/inference.md b/docs/docs/developers/plugins/inference.md similarity index 100% rename from docs/docs/apps/inference.md rename to docs/docs/developers/plugins/inference.md diff --git a/docs/docs/apps/model-management.md b/docs/docs/developers/plugins/model-management.md similarity index 100% rename from docs/docs/apps/model-management.md rename to docs/docs/developers/plugins/model-management.md diff --git a/docs/docs/apps/monitoring.md b/docs/docs/developers/plugins/monitoring.md similarity index 100% rename from docs/docs/apps/monitoring.md rename to docs/docs/developers/plugins/monitoring.md diff --git a/docs/docs/apps/rag.md b/docs/docs/developers/plugins/rag.md similarity index 100% rename from docs/docs/apps/rag.md rename to docs/docs/developers/plugins/rag.md diff --git a/docs/docs/guides/install/cloud-native.md b/docs/docs/guides/install/cloud-native.md index 773415d22..0bb0460fa 100644 --- a/docs/docs/guides/install/cloud-native.md +++ b/docs/docs/guides/install/cloud-native.md @@ -36,7 +36,7 @@ Open your browser at [http://localhost:4000](http://localhost:4000) ### Architecture -![cloudnative](../../getting-started/img/cloudnative.png) +![cloudnative](../../developers/img/cloudnative.png) ### TODOs diff --git a/docs/docs/getting-started/nitro.md b/docs/docs/nitro/nitro.md similarity index 95% rename from docs/docs/getting-started/nitro.md rename to docs/docs/nitro/nitro.md index e28035ae3..ae446b7a1 100644 --- a/docs/docs/getting-started/nitro.md +++ b/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) diff --git a/docs/sidebars.js b/docs/sidebars.js index 13d9c10d6..d725c4d50 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -48,39 +48,41 @@ const sidebars = { ], devSidebar: [ + "developers/developers", + "nitro/nitro", { type: "category", - label: "Getting Started", - collapsible: true, - collapsed: false, - items: [ - { - type: "autogenerated", - dirName: "getting-started", - }, - ], - }, - { - type: "category", - label: "Reference", - collapsible: true, - collapsed: false, - items: [ - { - type: "autogenerated", - dirName: "reference", - }, - ], - }, - { - type: "category", - label: "Apps (Plugins)", + label: "Apps", collapsible: true, collapsed: true, items: [ { type: "autogenerated", - dirName: "apps", + dirName: "developers/apps", + }, + ], + }, + { + type: "category", + label: "Plugins", + collapsible: true, + collapsed: true, + items: [ + { + type: "autogenerated", + dirName: "developers/plugins", + }, + ], + }, + { + type: "category", + label: "API Reference", + collapsible: true, + collapsed: true, + items: [ + { + type: "autogenerated", + dirName: "reference", }, ], },