docs: Jan architecture docs

This commit is contained in:
0xSage 2023-12-05 15:38:06 +07:00
parent 09fe295c85
commit 2e5da7eefc
6 changed files with 30 additions and 16 deletions

View File

@ -1,8 +1,18 @@
--- ---
title: Introduction title: Introduction
slug: /docs slug: /guides
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee] keywords:
[
Jan,
ChatGPT alternative,
on-premises AI,
local API server,
local AI,
llm,
conversational AI,
no-subscription fee,
]
--- ---
Jan is a ChatGPT-alternative that runs on your own computer, with a [local API server](/api). Jan is a ChatGPT-alternative that runs on your own computer, with a [local API server](/api).
@ -14,15 +24,19 @@ Jan believes in the need for an open source AI ecosystem. We aim to build infra
## Why Jan? ## Why Jan?
#### 💻 Own your AI #### 💻 Own your AI
Jan runs 100% on your own machine, [predictably](https://www.reddit.com/r/LocalLLaMA/comments/17mghqr/comment/k7ksti6/?utm_source=share&utm_medium=web2x&context=3), privately and even offline. No one else can see your conversations, not even us. Jan runs 100% on your own machine, [predictably](https://www.reddit.com/r/LocalLLaMA/comments/17mghqr/comment/k7ksti6/?utm_source=share&utm_medium=web2x&context=3), privately and even offline. No one else can see your conversations, not even us.
#### 🏗️ Extensions #### 🏗️ Extensions
Jan ships with a powerful [extension framework](/docs/extensions), which allows developers to extend and customize Jan's functionality. In fact, most core modules of Jan are [built as extensions](/specs/architecture) and use the same extensions API. Jan ships with a powerful [extension framework](/docs/extensions), which allows developers to extend and customize Jan's functionality. In fact, most core modules of Jan are [built as extensions](/specs/architecture) and use the same extensions API.
#### 🗂️ Open File Formats #### 🗂️ Open File Formats
Jan stores data in a [local folder of non-proprietary files](/specs/data-structures). You're never locked-in and can do what you want with your data with extensions, or even a different app. Jan stores data in a [local folder of non-proprietary files](/specs/data-structures). You're never locked-in and can do what you want with your data with extensions, or even a different app.
#### 🌍 Open Source #### 🌍 Open Source
Both Jan and [Nitro](https://nitro.jan.ai), our lightweight inference engine, are licensed via the open source [AGPLv3 license](https://github.com/janhq/jan/blob/main/LICENSE). Both Jan and [Nitro](https://nitro.jan.ai), our lightweight inference engine, are licensed via the open source [AGPLv3 license](https://github.com/janhq/jan/blob/main/LICENSE).
<!-- ## Design Principles --> <!-- ## Design Principles -->

View File

@ -17,10 +17,10 @@ const sidebars = {
{ {
type: "category", type: "category",
label: "Introduction", label: "Introduction",
link: { type: "doc", id: "intro/introduction" }, link: { type: "doc", id: "guides/introduction" },
collapsible: true, collapsible: true,
collapsed: true, collapsed: true,
items: ["intro/quickstart", "intro/how-jan-works"], items: ["guides/quickstart", "guides/how-jan-works"],
}, },
{ {
type: "category", type: "category",
@ -40,7 +40,7 @@ const sidebars = {
label: "Using Jan", label: "Using Jan",
collapsible: true, collapsible: true,
collapsed: true, collapsed: true,
items: ["docs/models", "docs/server"], items: ["guides/models", "guides/server"],
}, },
], ],