Merge pull request #625 from janhq/internal-48

Refactor Jan Documentation
This commit is contained in:
Daniel 2023-11-15 17:36:33 +08:00 committed by GitHub
commit a8a24e0671
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
23 changed files with 40 additions and 42 deletions

View File

@ -2,11 +2,11 @@
title: About Jan
---
Jan is a free, open source alternative to OpenAI's platform that runs on your personal computer.
Jan is a free, open source alternative to OpenAI's platform that runs on a local folder of open-format files.
We believe in the need for an open source AI ecosystem, and are building the infra and tooling to allow open source AIs to be as usable and comprehensive as proprietary ones.
Jan's long-term vision is to build a cognitive framework for future robots. We build towards a future where humans and businesses are augmented by practical, useful assistants in everyday life.
Jan's long-term vision is to build a cognitive framework for future robots, who are practical, useful assistants for humans and businesses in everyday life.
## Why does Jan Exist?

View File

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

View File

Before

Width:  |  Height:  |  Size: 86 KiB

After

Width:  |  Height:  |  Size: 86 KiB

View File

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

View File

Before

Width:  |  Height:  |  Size: 186 KiB

After

Width:  |  Height:  |  Size: 186 KiB

View File

Before

Width:  |  Height:  |  Size: 62 KiB

After

Width:  |  Height:  |  Size: 62 KiB

View File

Before

Width:  |  Height:  |  Size: 85 KiB

After

Width:  |  Height:  |  Size: 85 KiB

View File

Before

Width:  |  Height:  |  Size: 5.6 KiB

After

Width:  |  Height:  |  Size: 5.6 KiB

View File

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 54 KiB

View File

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

View File

@ -1,9 +0,0 @@
---
title: Overview
slug: /guides
---
- Jan Platform: Desktop app/ Cloud native SaaS that can run on Linux, Windows, Mac, or even a Server that comes with extensibilities, toolbox, and state-of-the-art but optimized models for next-gen Apps.
- Jan App: Next-gen App built on Jan Plaform as `portable intelligence` that can be run everywhere.
- Models:
- Large Language Models
- Stable Diffusion models

View File

@ -134,13 +134,7 @@ const config = {
src: "img/logo.svg",
},
items: [
// Navbar left
{
type: "docSidebar",
sidebarId: "guidesSidebar",
position: "left",
label: "User Guide",
},
// Navbar Left
{
type: "docSidebar",
sidebarId: "docsSidebar",

View File

@ -29,39 +29,52 @@ const sidebars = {
},
],
guidesSidebar: [
"guides/overview",
{
type: "category",
label: "Installation",
collapsible: true,
collapsed: false,
items: [
{
type: "autogenerated",
dirName: "guides/install",
},
],
},
"guides/troubleshooting",
],
docsSidebar: [
"docs/introduction",
"docs/quickstart",
{
type: "category",
label: "Modules",
collapsible: true,
label: "Getting Started",
collapsible: false,
collapsed: false,
items: [
"docs/introduction",
{
type: "autogenerated",
dirName: "docs/modules",
type: "category",
label: "Installation",
collapsible: true,
collapsed: true,
items: [
{
type: "autogenerated",
dirName: "getting-started/install",
},
],
},
"docs/quickstart",
],
},
{
type: "category",
label: "Building Jan",
collapsible: false,
collapsed: false,
items: [
"docs/user-interface",
{
type: "category",
label: "Specifications",
collapsible: true,
collapsed: true,
items: [
"docs/specs/chats",
"docs/specs/models",
"docs/specs/threads",
"docs/specs/messages",
"docs/specs/assistants",
"docs/specs/files",
],
},
],
},
"docs/user-interface",
],
apiSidebar: [