Merge pull request #1417 from janhq/docsOrg
docs: explain each docs page intent
This commit is contained in:
0xSage
GitHub
commit
fc151fb80c
@ -15,22 +15,36 @@ keywords:
|
||||
]
|
||||
---
|
||||
|
||||
Jan SDK is an **extensible framework** that lets you build and run AI applications everywhere, with an emphasis on local first.
|
||||
The following docs are aimed at developers who want to build extensions on top of the Jan Framework.
|
||||
|
||||
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.
|
||||
:::tip
|
||||
If you are interested to **contribute to the framework's Core SDK itself**, like adding new drivers, runtimes, and infrastracture level support, please refer to [framework docs](/docs) instead.
|
||||
:::
|
||||
|
||||
## Extensions
|
||||
|
||||
Jan an **extensible framework** (like VSCode or Obsidian) that lets you build, customize and run AI applications everywhere, with an emphasis on local first.
|
||||
|
||||
Extensions are automatically available across Mac, Windows, Linux Desktops.
|
||||
|
||||
Extensions can also be made available in local API server-mode, which can be deployed on any VM.
|
||||
|
||||
### Building Extensions
|
||||
|
||||
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:
|
||||
The framework 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.
|
||||
Build once, deploy everywhere
|
||||
:::
|
||||
|
||||
## Jan in Action
|
||||
|
||||
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.
|
||||
|
||||
[Gif: show desktop & server side by side]
|
||||
|
||||
@ -3,17 +3,17 @@ title: Overview
|
||||
slug: /docs
|
||||
---
|
||||
|
||||
The following low-level docs are aimed at core contributors and cover how to contribute to the Core SDK.
|
||||
The following low-level docs are aimed at core contributors and cover how to contribute to the core SDK.
|
||||
|
||||
:::tip
|
||||
If you are interested to **build on top of the SDK**, like creating assistants or adding app level extensions, please refer to [developer docs](/developer) instead.
|
||||
:::
|
||||
|
||||
## Core SDK
|
||||
## Jan Framework
|
||||
|
||||
At its Core, Jan is a cross-platform, local-first and AI native framework that can be used to build anything. In fact, current features are all implemented as 3rd party extensions on top of this Core SDK.
|
||||
At its core, Jan is a cross-platform, local-first and AI native framework that can be used to build anything. In fact, current features are all implemented as 3rd party extensions on top of this core SDK.
|
||||
|
||||
Ultimately, we aim for a VSCode or Obsidian like framework that allows devs to build and customize complex AI applications for their specific needs, in less than 15 minutes.
|
||||
Ultimately, we aim for a VSCode or Obsidian like framework that allows devs to build and customize complex AI applications for their specific needs, in less than 30 minutes.
|
||||
|
||||
### Cross Platform
|
||||
|
||||
|
||||
@ -15,20 +15,35 @@ keywords:
|
||||
]
|
||||
---
|
||||
|
||||
Jan is a ChatGPT alternative that runs on your own computer, with a [local API server](/guides/using-server).
|
||||
The following docs are aimed at end users who want to troubleshoot or learn how to use the **Jan Desktop** application better.
|
||||
|
||||
We believe in the need for an open source AI ecosystem. We're focused on building infra, tooling and [custom models](https://huggingface.co/janhq) to allow open source AIs to compete on a level playing field with proprietary offerings.
|
||||
:::tip
|
||||
If you are interested to build extensions, please refer to [developer docs](/developer) instead (WIP).
|
||||
|
||||
If you are interested to contribute to the underlying framework, please refer to [framework docs](/docs) instead.
|
||||
:::
|
||||
|
||||
## Jan Desktop
|
||||
|
||||
The desktop client is a ChatGPT alternative that runs on your own computer, with a [local API server](/guides/using-server).
|
||||
|
||||
## Features
|
||||
|
||||
- Compatible with [open-source models](/guides/using-models) (GGUF, TensorRT, and remote APIs)
|
||||
- Compatible with most OSes: [Windows](/install/windows/), [Mac](/install/mac), [Linux](/install/linux), with/without GPU acceleration
|
||||
- Compatible with [open-source models](/guides/using-models) (GGUF via [llama.cpp](https://github.com/ggerganov/llama.cpp), TensorRT via [TensorRT-LLM](https://github.com/NVIDIA/TensorRT-LLM), and [remote APIs](https://platform.openai.com/docs/api-reference))
|
||||
- Compatible with most OSes: [Windows](/install/windows/), [Mac](/install/mac), [Linux](/install/linux), with GPU acceleration through [llama.cpp](https://github.com/ggerganov/llama.cpp)
|
||||
- Stores data in [open file formats](/developer/file-based)
|
||||
- Local API [server mode](/guides/using-server)
|
||||
- Customizable via [extensions](/developer/build-extension)
|
||||
- And more in the [roadmap](https://github.com/orgs/janhq/projects/5/views/16). Join us on [Discord](https://discord.gg/5rQ2zTv3be) and tell us what you want to see!
|
||||
|
||||
## Why Jan?
|
||||
|
||||
We believe in the need for an open source AI ecosystem.
|
||||
|
||||
We're focused on building infra, tooling and [custom models](https://huggingface.co/janhq) to allow open source AIs to compete on a level playing field with proprietary offerings.
|
||||
|
||||
Read more about our mission and culture [here](/about).
|
||||
|
||||
#### 💻 Own your AI
|
||||
|
||||
Jan runs 100% on your own machine, predictably, privately and offline. No one else can see your conversations, not even us.
|
||||
|
||||
@ -237,7 +237,7 @@ const config = {
|
||||
type: "docSidebar",
|
||||
position: "left",
|
||||
sidebarId: "docsSidebar",
|
||||
label: "Docs",
|
||||
label: "Framework",
|
||||
},
|
||||
// Navbar right
|
||||
{
|
||||
@ -262,7 +262,14 @@ const config = {
|
||||
prism: {
|
||||
theme: darkCodeTheme,
|
||||
darkTheme: darkCodeTheme,
|
||||
additionalLanguages: ["python", "powershell", "bash", "json", "javascript", "jsx"],
|
||||
additionalLanguages: [
|
||||
"python",
|
||||
"powershell",
|
||||
"bash",
|
||||
"json",
|
||||
"javascript",
|
||||
"jsx",
|
||||
],
|
||||
},
|
||||
colorMode: {
|
||||
defaultMode: "light",
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user