docs: dev docs

This commit is contained in:
0xSage 2023-12-19 14:24:33 +08:00
parent 9849865dc6
commit b803dbe32c
10 changed files with 45 additions and 7 deletions

View File

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

View File

@ -1,5 +1,5 @@
---
title: Core
title: Core Extensions
---
:::caution

View File

@ -1,5 +1,5 @@
---
title: Common Extensions
title: Application Extensions
---
:::caution

View File

@ -1,5 +1,5 @@
---
title: Extension Guides
title: Application Extensions
---
:::caution

View File

@ -1,5 +1,5 @@
---
title: Assitant
title: Assistant
---
:::caution

View File

@ -1,5 +1,5 @@
---
title: UI
title: UI Kit
---
:::caution