Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Jan architecture docs

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
docs/docs/intro/how-jan-works.md → docs/docs/guides/how-jan-works.md
View File

40
docs/docs/intro/introduction.md → docs/docs/guides/introduction.md
View File

@ -1,36 +1,50 @@
---
title: Introduction
slug: /docs
slug: /guides
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).
Jan uses [open-source AI models](/docs/models), stores data in [open file formats](/specs/data-structures), is highly customizable via [extensions](/docs/extensions).
Jan uses [open-source AI models](/docs/models), stores data in [open file formats](/specs/data-structures), is highly customizable via [extensions](/docs/extensions).
Jan believes in the need for an open source AI ecosystem. We aim to build infra and tooling to allow open source AIs to compete on a level playing field with proprietary offerings.
Jan believes in the need for an open source AI ecosystem. We aim to build infra and tooling to allow open source AIs to compete on a level playing field with proprietary offerings.
## Why Jan?
#### 💻 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
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
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
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 -->
<!-- OpenAI meets VSCode meets Obsidian.
<!-- OpenAI meets VSCode meets Obsidian.
Minimalism: https://docusaurus.io/docs#design-principles. Not having abstractions is better than having the wrong abstractions. Assistants as code. Only including features that are absolutely necessary in the Jan API.
Minimalism: https://docusaurus.io/docs#design-principles. Not having abstractions is better than having the wrong abstractions. Assistants as code. Only including features that are absolutely necessary in the Jan API.
File-based: User should be able to look at a Jan directory and intuit how it works. Transparency. Editing things via a text editor, vs. needing a database tool for SQLite.
File-based: User should be able to look at a Jan directory and intuit how it works. Transparency. Editing things via a text editor, vs. needing a database tool for SQLite.
Participatory: https://www.getlago.com/blog/the-5-reasons-why-we-chose-open-source -->
Participatory: https://www.getlago.com/blog/the-5-reasons-why-we-chose-open-source -->

0
docs/docs/docs/models.md → docs/docs/guides/models.md
View File

0
docs/docs/intro/quickstart.md → docs/docs/guides/quickstart.md
View File

0
docs/docs/docs/server.md → docs/docs/guides/server.md
View File

6
docs/sidebars.js
View File

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