diff --git a/docs/docs/docs/01-overview.md b/docs/docs/docs/01-overview.md index 03d5592e1..8b1860198 100644 --- a/docs/docs/docs/01-overview.md +++ b/docs/docs/docs/01-overview.md @@ -15,6 +15,44 @@ keywords: ] --- -:::caution -This is currently under development. +Jan SDK is an **extensible framework** that lets you build and run AI applications everywhere, with an emphasis on local first. + +It is available across Mac, Windows, Linux Desktops. It is also available as a headless server that can be deployed into any on-prem or cloud environments. + +This framework is packaged and regularly published as an SDK through [npm](https://www.npmjs.com/org/janhq) and [pip](https://pypi.org/). + +The SDK provides built-in support for the following: + +- Native OS integrations with Electron and Chromium +- Native server integrations with Nodejs +- Native mobile integrations with Capacitor (coming soon) + +:::tip +The [Jan Desktop client](https://github.com/janhq/jan/releases) is built with Jan SDK. This means you can customize any part of the application from the branding to the features, and truly make it your own. ::: + +## Jan in Action + +[Gif: show desktop & server side by side] + +## Application Extensions + +You can make feature level additions to Jan to extend the application UI & use cases. + +Jan's growing developer community is constantly adding new integrations that improve your productivity. + +Read more about [application extensions](/docs/extension-capabilities/application). + +## Core Extensions + +You can make framework or driver level additions to Jan to extend how Jan natively runs on your infrastructure. For example, you can customize inline OS commands or even integrate Jan with your IoT. + +Core Extension improvements can be packaged back into the core SDK and distributed to other extension developers. + +Read more about [core extensions](/docs/extension-capabilities/core/) + +## UI Kit + +Jan ships with an AI friendly UI kit that can be used with Jan SDK or any other Javascript project. + +Read more about our [ui kit](/docs/ui-kit) diff --git a/docs/docs/docs/03-extension-capabilities/01-Core.md b/docs/docs/docs/03-extension-capabilities/01-Core.md index 09a6dc26d..c84b45d89 100644 --- a/docs/docs/docs/03-extension-capabilities/01-Core.md +++ b/docs/docs/docs/03-extension-capabilities/01-Core.md @@ -1,5 +1,5 @@ --- -title: Core +title: Core Extensions --- :::caution diff --git a/docs/docs/docs/03-extension-capabilities/02-common-extensions.md b/docs/docs/docs/03-extension-capabilities/02-application.mdx similarity index 67% rename from docs/docs/docs/03-extension-capabilities/02-common-extensions.md rename to docs/docs/docs/03-extension-capabilities/02-application.mdx index 68aa0f12a..452394f33 100644 --- a/docs/docs/docs/03-extension-capabilities/02-common-extensions.md +++ b/docs/docs/docs/03-extension-capabilities/02-application.mdx @@ -1,5 +1,5 @@ --- -title: Common Extensions +title: Application Extensions --- :::caution diff --git a/docs/docs/docs/04-extension-guides/README.md b/docs/docs/docs/04-application-extensions/README.md similarity index 67% rename from docs/docs/docs/04-extension-guides/README.md rename to docs/docs/docs/04-application-extensions/README.md index 1ef5a6967..452394f33 100644 --- a/docs/docs/docs/04-extension-guides/README.md +++ b/docs/docs/docs/04-application-extensions/README.md @@ -1,5 +1,5 @@ --- -title: Extension Guides +title: Application Extensions --- :::caution diff --git a/docs/docs/docs/04-extension-guides/assistant.md b/docs/docs/docs/04-application-extensions/assistant.md similarity index 78% rename from docs/docs/docs/04-extension-guides/assistant.md rename to docs/docs/docs/04-application-extensions/assistant.md index dd907837e..21378ad8e 100644 --- a/docs/docs/docs/04-extension-guides/assistant.md +++ b/docs/docs/docs/04-application-extensions/assistant.md @@ -1,5 +1,5 @@ --- -title: Assitant +title: Assistant --- :::caution diff --git a/docs/docs/docs/04-extension-guides/inference.md b/docs/docs/docs/04-application-extensions/inference.md similarity index 100% rename from docs/docs/docs/04-extension-guides/inference.md rename to docs/docs/docs/04-application-extensions/inference.md diff --git a/docs/docs/docs/04-extension-guides/model.md b/docs/docs/docs/04-application-extensions/model.md similarity index 100% rename from docs/docs/docs/04-extension-guides/model.md rename to docs/docs/docs/04-application-extensions/model.md diff --git a/docs/docs/docs/04-extension-guides/monitoring.md b/docs/docs/docs/04-application-extensions/monitoring.md similarity index 100% rename from docs/docs/docs/04-extension-guides/monitoring.md rename to docs/docs/docs/04-application-extensions/monitoring.md diff --git a/docs/docs/docs/04-extension-guides/threads-messages.md b/docs/docs/docs/04-application-extensions/threads-messages.md similarity index 100% rename from docs/docs/docs/04-extension-guides/threads-messages.md rename to docs/docs/docs/04-application-extensions/threads-messages.md diff --git a/docs/docs/docs/05-UI/README.md b/docs/docs/docs/05-ui-kit/README.md similarity index 81% rename from docs/docs/docs/05-UI/README.md rename to docs/docs/docs/05-ui-kit/README.md index 16e35b025..14196dd0f 100644 --- a/docs/docs/docs/05-UI/README.md +++ b/docs/docs/docs/05-ui-kit/README.md @@ -1,5 +1,5 @@ --- -title: UI +title: UI Kit --- :::caution