From cb3c70025f71aff7e1836b859d6102d251f35903 Mon Sep 17 00:00:00 2001 From: Arista Indrajaya Date: Mon, 4 Mar 2024 13:22:45 +0700 Subject: [PATCH] docs: input framework menu into /developer slug --- .../01-overview/04-install-and-prerequisites.md | 2 +- docs/docs/developer/01-overview/README.md | 2 +- .../05-framework}/03-engineering/README.mdx | 0 .../05-framework}/03-engineering/assistants.md | 0 .../05-framework}/03-engineering/chats.md | 0 .../05-framework}/03-engineering/engine.md | 0 .../05-framework}/03-engineering/files.md | 0 .../05-framework}/03-engineering/fine-tuning.md | 0 .../05-framework}/03-engineering/messages.md | 0 .../05-framework}/03-engineering/models.md | 0 .../05-framework}/03-engineering/prompts.md | 0 .../05-framework}/03-engineering/threads.md | 0 .../05-framework}/03-product/README.mdx | 0 .../05-framework}/03-product/chat.md | 0 .../05-framework}/03-product/hub.md | 0 .../05-framework}/03-product/jan.md | 0 .../05-framework}/03-product/settings.md | 0 .../05-framework}/03-product/system-monitor.md | 0 .../05-framework/README.md} | 16 ++++++++++++++-- .../05-framework}/assets/CleanArchitecture.jpg | Bin .../05-framework}/assets/ExtensionCallouts.png | Bin .../05-framework}/image.png | Bin .../05-framework}/img/chat-screen.png | Bin .../05-framework}/img/hub-screen.png | Bin .../05-framework}/img/settings-screen.png | Bin .../05-framework}/img/system-screen.png | Bin 26 files changed, 16 insertions(+), 4 deletions(-) rename docs/docs/{framework => developer/05-framework}/03-engineering/README.mdx (100%) rename docs/docs/{framework => developer/05-framework}/03-engineering/assistants.md (100%) rename docs/docs/{framework => developer/05-framework}/03-engineering/chats.md (100%) rename docs/docs/{framework => developer/05-framework}/03-engineering/engine.md (100%) rename docs/docs/{framework => developer/05-framework}/03-engineering/files.md (100%) rename docs/docs/{framework => developer/05-framework}/03-engineering/fine-tuning.md (100%) rename docs/docs/{framework => developer/05-framework}/03-engineering/messages.md (100%) rename docs/docs/{framework => developer/05-framework}/03-engineering/models.md (100%) rename docs/docs/{framework => developer/05-framework}/03-engineering/prompts.md (100%) rename docs/docs/{framework => developer/05-framework}/03-engineering/threads.md (100%) rename docs/docs/{framework => developer/05-framework}/03-product/README.mdx (100%) rename docs/docs/{framework => developer/05-framework}/03-product/chat.md (100%) rename docs/docs/{framework => developer/05-framework}/03-product/hub.md (100%) rename docs/docs/{framework => developer/05-framework}/03-product/jan.md (100%) rename docs/docs/{framework => developer/05-framework}/03-product/settings.md (100%) rename docs/docs/{framework => developer/05-framework}/03-product/system-monitor.md (100%) rename docs/docs/{framework/01-README.md => developer/05-framework/README.md} (93%) rename docs/docs/{framework => developer/05-framework}/assets/CleanArchitecture.jpg (100%) rename docs/docs/{framework => developer/05-framework}/assets/ExtensionCallouts.png (100%) rename docs/docs/{framework => developer/05-framework}/image.png (100%) rename docs/docs/{framework => developer/05-framework}/img/chat-screen.png (100%) rename docs/docs/{framework => developer/05-framework}/img/hub-screen.png (100%) rename docs/docs/{framework => developer/05-framework}/img/settings-screen.png (100%) rename docs/docs/{framework => developer/05-framework}/img/system-screen.png (100%) diff --git a/docs/docs/developer/01-overview/04-install-and-prerequisites.md b/docs/docs/developer/01-overview/04-install-and-prerequisites.md index 110f62e36..9752f7b72 100644 --- a/docs/docs/developer/01-overview/04-install-and-prerequisites.md +++ b/docs/docs/developer/01-overview/04-install-and-prerequisites.md @@ -24,7 +24,7 @@ keywords: Ensure your system meets the following specifications to guarantee a smooth development experience: -- [Hardware Requirements](../../guides/02-installation/06-hardware.md) +- Hardware Requirements ### System Requirements diff --git a/docs/docs/developer/01-overview/README.md b/docs/docs/developer/01-overview/README.md index 98e1b1164..7bc3524de 100644 --- a/docs/docs/developer/01-overview/README.md +++ b/docs/docs/developer/01-overview/README.md @@ -18,7 +18,7 @@ keywords: The following docs are aimed at developers who want to build extensions on top of the Jan Framework. :::tip -If you are interested to **contribute to the framework's Core SDK itself**, like adding new drivers, runtimes, and infrastructure level support, please refer to [framework docs](/docs) instead. +If you are interested to **contribute to the framework's Core SDK itself**, like adding new drivers, runtimes, and infrastructure level support, please refer to [framework docs](/developer/framework) instead. ::: ## Extensions diff --git a/docs/docs/framework/03-engineering/README.mdx b/docs/docs/developer/05-framework/03-engineering/README.mdx similarity index 100% rename from docs/docs/framework/03-engineering/README.mdx rename to docs/docs/developer/05-framework/03-engineering/README.mdx diff --git a/docs/docs/framework/03-engineering/assistants.md b/docs/docs/developer/05-framework/03-engineering/assistants.md similarity index 100% rename from docs/docs/framework/03-engineering/assistants.md rename to docs/docs/developer/05-framework/03-engineering/assistants.md diff --git a/docs/docs/framework/03-engineering/chats.md b/docs/docs/developer/05-framework/03-engineering/chats.md similarity index 100% rename from docs/docs/framework/03-engineering/chats.md rename to docs/docs/developer/05-framework/03-engineering/chats.md diff --git a/docs/docs/framework/03-engineering/engine.md b/docs/docs/developer/05-framework/03-engineering/engine.md similarity index 100% rename from docs/docs/framework/03-engineering/engine.md rename to docs/docs/developer/05-framework/03-engineering/engine.md diff --git a/docs/docs/framework/03-engineering/files.md b/docs/docs/developer/05-framework/03-engineering/files.md similarity index 100% rename from docs/docs/framework/03-engineering/files.md rename to docs/docs/developer/05-framework/03-engineering/files.md diff --git a/docs/docs/framework/03-engineering/fine-tuning.md b/docs/docs/developer/05-framework/03-engineering/fine-tuning.md similarity index 100% rename from docs/docs/framework/03-engineering/fine-tuning.md rename to docs/docs/developer/05-framework/03-engineering/fine-tuning.md diff --git a/docs/docs/framework/03-engineering/messages.md b/docs/docs/developer/05-framework/03-engineering/messages.md similarity index 100% rename from docs/docs/framework/03-engineering/messages.md rename to docs/docs/developer/05-framework/03-engineering/messages.md diff --git a/docs/docs/framework/03-engineering/models.md b/docs/docs/developer/05-framework/03-engineering/models.md similarity index 100% rename from docs/docs/framework/03-engineering/models.md rename to docs/docs/developer/05-framework/03-engineering/models.md diff --git a/docs/docs/framework/03-engineering/prompts.md b/docs/docs/developer/05-framework/03-engineering/prompts.md similarity index 100% rename from docs/docs/framework/03-engineering/prompts.md rename to docs/docs/developer/05-framework/03-engineering/prompts.md diff --git a/docs/docs/framework/03-engineering/threads.md b/docs/docs/developer/05-framework/03-engineering/threads.md similarity index 100% rename from docs/docs/framework/03-engineering/threads.md rename to docs/docs/developer/05-framework/03-engineering/threads.md diff --git a/docs/docs/framework/03-product/README.mdx b/docs/docs/developer/05-framework/03-product/README.mdx similarity index 100% rename from docs/docs/framework/03-product/README.mdx rename to docs/docs/developer/05-framework/03-product/README.mdx diff --git a/docs/docs/framework/03-product/chat.md b/docs/docs/developer/05-framework/03-product/chat.md similarity index 100% rename from docs/docs/framework/03-product/chat.md rename to docs/docs/developer/05-framework/03-product/chat.md diff --git a/docs/docs/framework/03-product/hub.md b/docs/docs/developer/05-framework/03-product/hub.md similarity index 100% rename from docs/docs/framework/03-product/hub.md rename to docs/docs/developer/05-framework/03-product/hub.md diff --git a/docs/docs/framework/03-product/jan.md b/docs/docs/developer/05-framework/03-product/jan.md similarity index 100% rename from docs/docs/framework/03-product/jan.md rename to docs/docs/developer/05-framework/03-product/jan.md diff --git a/docs/docs/framework/03-product/settings.md b/docs/docs/developer/05-framework/03-product/settings.md similarity index 100% rename from docs/docs/framework/03-product/settings.md rename to docs/docs/developer/05-framework/03-product/settings.md diff --git a/docs/docs/framework/03-product/system-monitor.md b/docs/docs/developer/05-framework/03-product/system-monitor.md similarity index 100% rename from docs/docs/framework/03-product/system-monitor.md rename to docs/docs/developer/05-framework/03-product/system-monitor.md diff --git a/docs/docs/framework/01-README.md b/docs/docs/developer/05-framework/README.md similarity index 93% rename from docs/docs/framework/01-README.md rename to docs/docs/developer/05-framework/README.md index 752e30752..770f5713a 100644 --- a/docs/docs/framework/01-README.md +++ b/docs/docs/developer/05-framework/README.md @@ -1,6 +1,18 @@ --- -title: Overview -slug: /framework +title: Framework +slug: /developer/framework/ +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, + ] --- The following low-level docs are aimed at core contributors. diff --git a/docs/docs/framework/assets/CleanArchitecture.jpg b/docs/docs/developer/05-framework/assets/CleanArchitecture.jpg similarity index 100% rename from docs/docs/framework/assets/CleanArchitecture.jpg rename to docs/docs/developer/05-framework/assets/CleanArchitecture.jpg diff --git a/docs/docs/framework/assets/ExtensionCallouts.png b/docs/docs/developer/05-framework/assets/ExtensionCallouts.png similarity index 100% rename from docs/docs/framework/assets/ExtensionCallouts.png rename to docs/docs/developer/05-framework/assets/ExtensionCallouts.png diff --git a/docs/docs/framework/image.png b/docs/docs/developer/05-framework/image.png similarity index 100% rename from docs/docs/framework/image.png rename to docs/docs/developer/05-framework/image.png diff --git a/docs/docs/framework/img/chat-screen.png b/docs/docs/developer/05-framework/img/chat-screen.png similarity index 100% rename from docs/docs/framework/img/chat-screen.png rename to docs/docs/developer/05-framework/img/chat-screen.png diff --git a/docs/docs/framework/img/hub-screen.png b/docs/docs/developer/05-framework/img/hub-screen.png similarity index 100% rename from docs/docs/framework/img/hub-screen.png rename to docs/docs/developer/05-framework/img/hub-screen.png diff --git a/docs/docs/framework/img/settings-screen.png b/docs/docs/developer/05-framework/img/settings-screen.png similarity index 100% rename from docs/docs/framework/img/settings-screen.png rename to docs/docs/developer/05-framework/img/settings-screen.png diff --git a/docs/docs/framework/img/system-screen.png b/docs/docs/developer/05-framework/img/system-screen.png similarity index 100% rename from docs/docs/framework/img/system-screen.png rename to docs/docs/developer/05-framework/img/system-screen.png