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", }, ], },