From 2e5da7eefcf024b1d0c22156e68f386f371c3d0c Mon Sep 17 00:00:00 2001 From: 0xSage Date: Tue, 5 Dec 2023 15:38:06 +0700 Subject: [PATCH 1/3] docs: Jan architecture docs --- docs/docs/{intro => guides}/how-jan-works.md | 0 docs/docs/{intro => guides}/introduction.md | 40 +++++++++++++------- docs/docs/{docs => guides}/models.md | 0 docs/docs/{intro => guides}/quickstart.md | 0 docs/docs/{docs => guides}/server.md | 0 docs/sidebars.js | 6 +-- 6 files changed, 30 insertions(+), 16 deletions(-) rename docs/docs/{intro => guides}/how-jan-works.md (100%) rename docs/docs/{intro => guides}/introduction.md (71%) rename docs/docs/{docs => guides}/models.md (100%) rename docs/docs/{intro => guides}/quickstart.md (100%) rename docs/docs/{docs => guides}/server.md (100%) diff --git a/docs/docs/intro/how-jan-works.md b/docs/docs/guides/how-jan-works.md similarity index 100% rename from docs/docs/intro/how-jan-works.md rename to docs/docs/guides/how-jan-works.md diff --git a/docs/docs/intro/introduction.md b/docs/docs/guides/introduction.md similarity index 71% rename from docs/docs/intro/introduction.md rename to docs/docs/guides/introduction.md index 1501cfc4b..667b0b9d7 100644 --- a/docs/docs/intro/introduction.md +++ b/docs/docs/guides/introduction.md @@ -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). - \ No newline at end of file +Participatory: https://www.getlago.com/blog/the-5-reasons-why-we-chose-open-source --> diff --git a/docs/docs/docs/models.md b/docs/docs/guides/models.md similarity index 100% rename from docs/docs/docs/models.md rename to docs/docs/guides/models.md diff --git a/docs/docs/intro/quickstart.md b/docs/docs/guides/quickstart.md similarity index 100% rename from docs/docs/intro/quickstart.md rename to docs/docs/guides/quickstart.md diff --git a/docs/docs/docs/server.md b/docs/docs/guides/server.md similarity index 100% rename from docs/docs/docs/server.md rename to docs/docs/guides/server.md diff --git a/docs/sidebars.js b/docs/sidebars.js index 384f47e9d..8d56cac63 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -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"], }, ], From fe343a7f8d4b7c08c0b88089ae382be04e8c26d3 Mon Sep 17 00:00:00 2001 From: 0xSage Date: Wed, 13 Dec 2023 14:08:07 +0800 Subject: [PATCH 2/3] docs: scaffold docs --- docs/docs/docs/01-overview.md | 20 +++++++++++++++++++ .../docs/02-get-started/01-build-extension.md | 7 +++++++ .../02-get-started/02-extension-anatomy.md | 9 +++++++++ .../02-get-started/03-use-local-server.md | 7 +++++++ .../02-get-started/04-build-on-desktop.md | 7 +++++++ .../docs/02-get-started/05-build-on-mobile.md | 7 +++++++ docs/docs/docs/02-get-started/README.md | 12 +++++++++++ .../docs/03-extension-capabilities/01-Core.md | 7 +++++++ .../02-Common Extensions.md | 7 +++++++ .../docs/03-extension-capabilities/README.md | 9 +++++++++ docs/docs/docs/04-extension-guides/README.md | 7 +++++++ .../docs/04-extension-guides/assistant.md | 7 +++++++ .../docs/04-extension-guides/inference.md | 7 +++++++ docs/docs/docs/04-extension-guides/model.md | 7 +++++++ .../docs/04-extension-guides/monitoring.md | 7 +++++++ .../04-extension-guides/threads-messages.md | 7 +++++++ docs/docs/docs/05-UI/README.md | 7 +++++++ docs/docs/docs/assistants.md | 5 ----- docs/docs/docs/extensions.md | 11 ---------- docs/docs/docs/modules.md | 5 ----- docs/docs/docs/themes.md | 5 ----- docs/docs/docs/tools.md | 5 ----- docs/sidebars.js | 9 ++++----- 23 files changed, 145 insertions(+), 36 deletions(-) create mode 100644 docs/docs/docs/01-overview.md create mode 100644 docs/docs/docs/02-get-started/01-build-extension.md create mode 100644 docs/docs/docs/02-get-started/02-extension-anatomy.md create mode 100644 docs/docs/docs/02-get-started/03-use-local-server.md create mode 100644 docs/docs/docs/02-get-started/04-build-on-desktop.md create mode 100644 docs/docs/docs/02-get-started/05-build-on-mobile.md create mode 100644 docs/docs/docs/02-get-started/README.md create mode 100644 docs/docs/docs/03-extension-capabilities/01-Core.md create mode 100644 docs/docs/docs/03-extension-capabilities/02-Common Extensions.md create mode 100644 docs/docs/docs/03-extension-capabilities/README.md create mode 100644 docs/docs/docs/04-extension-guides/README.md create mode 100644 docs/docs/docs/04-extension-guides/assistant.md create mode 100644 docs/docs/docs/04-extension-guides/inference.md create mode 100644 docs/docs/docs/04-extension-guides/model.md create mode 100644 docs/docs/docs/04-extension-guides/monitoring.md create mode 100644 docs/docs/docs/04-extension-guides/threads-messages.md create mode 100644 docs/docs/docs/05-UI/README.md delete mode 100644 docs/docs/docs/assistants.md delete mode 100644 docs/docs/docs/extensions.md delete mode 100644 docs/docs/docs/modules.md delete mode 100644 docs/docs/docs/themes.md delete mode 100644 docs/docs/docs/tools.md diff --git a/docs/docs/docs/01-overview.md b/docs/docs/docs/01-overview.md new file mode 100644 index 000000000..03d5592e1 --- /dev/null +++ b/docs/docs/docs/01-overview.md @@ -0,0 +1,20 @@ +--- +title: Overview +slug: /docs +description: Jan Docs | Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/02-get-started/01-build-extension.md b/docs/docs/docs/02-get-started/01-build-extension.md new file mode 100644 index 000000000..e84f25604 --- /dev/null +++ b/docs/docs/docs/02-get-started/01-build-extension.md @@ -0,0 +1,7 @@ +--- +title: Build an Extension +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/02-get-started/02-extension-anatomy.md b/docs/docs/docs/02-get-started/02-extension-anatomy.md new file mode 100644 index 000000000..c4a372004 --- /dev/null +++ b/docs/docs/docs/02-get-started/02-extension-anatomy.md @@ -0,0 +1,9 @@ +--- +title: Anatomy of an Extension +--- + +:::caution +This is currently under development. +::: + +Anatomy and lifecycle diff --git a/docs/docs/docs/02-get-started/03-use-local-server.md b/docs/docs/docs/02-get-started/03-use-local-server.md new file mode 100644 index 000000000..e6b3f4627 --- /dev/null +++ b/docs/docs/docs/02-get-started/03-use-local-server.md @@ -0,0 +1,7 @@ +--- +title: Using the Local Server +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/02-get-started/04-build-on-desktop.md b/docs/docs/docs/02-get-started/04-build-on-desktop.md new file mode 100644 index 000000000..e652953a0 --- /dev/null +++ b/docs/docs/docs/02-get-started/04-build-on-desktop.md @@ -0,0 +1,7 @@ +--- +title: Building for Desktop +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/02-get-started/05-build-on-mobile.md b/docs/docs/docs/02-get-started/05-build-on-mobile.md new file mode 100644 index 000000000..9a12f44a4 --- /dev/null +++ b/docs/docs/docs/02-get-started/05-build-on-mobile.md @@ -0,0 +1,7 @@ +--- +title: Building for Mobile +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/02-get-started/README.md b/docs/docs/docs/02-get-started/README.md new file mode 100644 index 000000000..3c8409423 --- /dev/null +++ b/docs/docs/docs/02-get-started/README.md @@ -0,0 +1,12 @@ +--- +title: Get Started +--- + +:::caution +This is currently under development. +::: +There are various ways to build on top of Jan. + +1. Use Jan as a local AI server +2. Build a cross-platform extension for Desktop application +3. ... diff --git a/docs/docs/docs/03-extension-capabilities/01-Core.md b/docs/docs/docs/03-extension-capabilities/01-Core.md new file mode 100644 index 000000000..09a6dc26d --- /dev/null +++ b/docs/docs/docs/03-extension-capabilities/01-Core.md @@ -0,0 +1,7 @@ +--- +title: Core +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/03-extension-capabilities/02-Common Extensions.md b/docs/docs/docs/03-extension-capabilities/02-Common Extensions.md new file mode 100644 index 000000000..68aa0f12a --- /dev/null +++ b/docs/docs/docs/03-extension-capabilities/02-Common Extensions.md @@ -0,0 +1,7 @@ +--- +title: Common Extensions +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/03-extension-capabilities/README.md b/docs/docs/docs/03-extension-capabilities/README.md new file mode 100644 index 000000000..2a52325b1 --- /dev/null +++ b/docs/docs/docs/03-extension-capabilities/README.md @@ -0,0 +1,9 @@ +--- +title: Extension Capabilities +--- + +# Overview + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/04-extension-guides/README.md b/docs/docs/docs/04-extension-guides/README.md new file mode 100644 index 000000000..1ef5a6967 --- /dev/null +++ b/docs/docs/docs/04-extension-guides/README.md @@ -0,0 +1,7 @@ +--- +title: Extension Guides +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/04-extension-guides/assistant.md b/docs/docs/docs/04-extension-guides/assistant.md new file mode 100644 index 000000000..dd907837e --- /dev/null +++ b/docs/docs/docs/04-extension-guides/assistant.md @@ -0,0 +1,7 @@ +--- +title: Assitant +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/04-extension-guides/inference.md b/docs/docs/docs/04-extension-guides/inference.md new file mode 100644 index 000000000..d333f02f3 --- /dev/null +++ b/docs/docs/docs/04-extension-guides/inference.md @@ -0,0 +1,7 @@ +--- +title: Inference +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/04-extension-guides/model.md b/docs/docs/docs/04-extension-guides/model.md new file mode 100644 index 000000000..77f27c94d --- /dev/null +++ b/docs/docs/docs/04-extension-guides/model.md @@ -0,0 +1,7 @@ +--- +title: Model +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/04-extension-guides/monitoring.md b/docs/docs/docs/04-extension-guides/monitoring.md new file mode 100644 index 000000000..1f6d6af46 --- /dev/null +++ b/docs/docs/docs/04-extension-guides/monitoring.md @@ -0,0 +1,7 @@ +--- +title: Monitoring +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/04-extension-guides/threads-messages.md b/docs/docs/docs/04-extension-guides/threads-messages.md new file mode 100644 index 000000000..b56f8d98a --- /dev/null +++ b/docs/docs/docs/04-extension-guides/threads-messages.md @@ -0,0 +1,7 @@ +--- +title: Thread & Messages +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/05-UI/README.md b/docs/docs/docs/05-UI/README.md new file mode 100644 index 000000000..16e35b025 --- /dev/null +++ b/docs/docs/docs/05-UI/README.md @@ -0,0 +1,7 @@ +--- +title: UI +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/assistants.md b/docs/docs/docs/assistants.md deleted file mode 100644 index 612229af3..000000000 --- a/docs/docs/docs/assistants.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Build an Assistant -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] ---- \ No newline at end of file diff --git a/docs/docs/docs/extensions.md b/docs/docs/docs/extensions.md deleted file mode 100644 index 11128ec41..000000000 --- a/docs/docs/docs/extensions.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Extending Jan -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] ---- - -## Overview - -- Jan exports a developer SDK which lets you customize assistants, Jan app, and more. -- Jan exports a AI-friendly UI kit which lets people customize the [Jan UI](/specs/user-interface). -- Jan provisions a local AI server which lets you built external applications on other platforms. diff --git a/docs/docs/docs/modules.md b/docs/docs/docs/modules.md deleted file mode 100644 index 3cec1aa3b..000000000 --- a/docs/docs/docs/modules.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Build a Module -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] ---- \ No newline at end of file diff --git a/docs/docs/docs/themes.md b/docs/docs/docs/themes.md deleted file mode 100644 index 8760d3ca6..000000000 --- a/docs/docs/docs/themes.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Build a Theme -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] ---- \ No newline at end of file diff --git a/docs/docs/docs/tools.md b/docs/docs/docs/tools.md deleted file mode 100644 index e7a0cb85d..000000000 --- a/docs/docs/docs/tools.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Build a Tool -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] ---- \ No newline at end of file diff --git a/docs/sidebars.js b/docs/sidebars.js index 8d56cac63..51db7fcb8 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -45,11 +45,10 @@ const sidebars = { ], developerSidebar: [ - "docs/extensions", - "docs/assistants", - "docs/themes", - "docs/tools", - "docs/modules", + { + type: "autogenerated", + dirName: "docs", + }, ], specsSidebar: [ From 223877615c411eb2592fed059066c305a5ef3729 Mon Sep 17 00:00:00 2001 From: 0xSage Date: Wed, 13 Dec 2023 14:08:47 +0800 Subject: [PATCH 3/3] docs: fix filename --- .../{02-Common Extensions.md => 02-common-extensions.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/docs/docs/03-extension-capabilities/{02-Common Extensions.md => 02-common-extensions.md} (100%) diff --git a/docs/docs/docs/03-extension-capabilities/02-Common Extensions.md b/docs/docs/docs/03-extension-capabilities/02-common-extensions.md similarity index 100% rename from docs/docs/docs/03-extension-capabilities/02-Common Extensions.md rename to docs/docs/docs/03-extension-capabilities/02-common-extensions.md