diff --git a/docs/docs/getting-started/cloud-native.md b/docs/docs/guides/install/cloud-native.md similarity index 91% rename from docs/docs/getting-started/cloud-native.md rename to docs/docs/guides/install/cloud-native.md index 7db615dfe..773415d22 100644 --- a/docs/docs/getting-started/cloud-native.md +++ b/docs/docs/guides/install/cloud-native.md @@ -1,8 +1,9 @@ --- -sidebar_position: 5 title: Cloud Native --- +# Installing Jan Cloud Native + Cloud Native is useful when you want to deploy Jan to a shared/remote/cloud server, rather than running it as a local Desktop app. > This is an experimental feature - expect breaking changes! @@ -35,7 +36,7 @@ Open your browser at [http://localhost:4000](http://localhost:4000) ### Architecture -![cloudnative](img/cloudnative.png) +![cloudnative](../../getting-started/img/cloudnative.png) ### TODOs diff --git a/docs/docs/guides/install/install.md b/docs/docs/guides/install/install.md new file mode 100644 index 000000000..5bc823348 --- /dev/null +++ b/docs/docs/guides/install/install.md @@ -0,0 +1,3 @@ +--- +title: Installation +--- \ No newline at end of file diff --git a/docs/docs/guides/linux.md b/docs/docs/guides/install/linux.md similarity index 76% rename from docs/docs/guides/linux.md rename to docs/docs/guides/install/linux.md index 067c9f54e..34158cae2 100644 --- a/docs/docs/guides/linux.md +++ b/docs/docs/guides/install/linux.md @@ -1,16 +1,18 @@ --- -title: Installing Jan on Linux -sidebar_position: 4 +title: Linux --- -# Linux users -## Step 1: Download the Installer +# Installing Jan on Linux + +## Installation + +### Step 1: Download the Installer To begin using 👋Jan.ai on your Windows computer, follow these steps: 1. Visit [Jan.ai](https://jan.ai/). 2. Click on the "Download for Windows" button to download the Jan Installer. -![Jan Installer](img/jan-download.png) +![Jan Installer](../img/jan-download.png) :::tip @@ -34,37 +36,42 @@ For AMD GPU. You can download it from your Linux distro's package manager or fro ::: -## Step 2: Download your first model +### Step 2: Download your first model Now, let's get your first model: 1. After installation, you'll find the 👋Jan application icon on your desktop. Double-click to open it. 2. Welcome to the Jan homepage. Click on "Explore Models" to see the Model catalog. -![Explore models](img/explore-model.png) +![Explore models](../img/explore-model.png) 3. You can also see different quantized versions by clicking on "Show Available Versions." -![Model versions](img/model-version.png) +![Model versions](../img/model-version.png) > Note: Choose a model that matches your computer's memory and RAM. 4. Select your preferred model and click "Download." -![Downloading](img/downloading.PNG) +![Downloading](../img/downloading.png) -## Step 3: Start the model +### Step 3: Start the model Once your model is downloaded. Go to "My Models" and then click "Start Model." -![Start model](img/start-model.PNG) +![Start model](../img/start-model.png) -## Step 4: Start the conversations + +### Step 4: Start the conversations Now you're ready to start using 👋Jan.ai for conversations: Click "Chat" and begin your first conversation by selecting "New conversation." You can also check the CPU and Memory usage of the computer. -![Chat](img/chat.PNG) +![Chat](../img/chat.png) -That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai. \ No newline at end of file +That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai. + +## Uninstallation + +## Troubleshooting \ No newline at end of file diff --git a/docs/docs/guides/mac.md b/docs/docs/guides/install/mac.md similarity index 68% rename from docs/docs/guides/mac.md rename to docs/docs/guides/install/mac.md index 13c8033ed..e3bbc353b 100644 --- a/docs/docs/guides/mac.md +++ b/docs/docs/guides/install/mac.md @@ -1,48 +1,52 @@ --- -title: Installing Jan on Mac -sidebar_position: 2 +title: Mac --- -# Mac users -## Step 1: Download the Installer +## Installation + +### Step 1: Download the Installer To begin using 👋Jan.ai on your Windows computer, follow these steps: 1. Visit [Jan.ai](https://jan.ai/). 2. Click on the "Download for Windows" button to download the Jan Installer. -![Jan Installer](img/jan-download.png) +![Jan Installer](../img/jan-download.png) -## Step 2: Download your first model +### Step 2: Download your first model Now, let's get your first model: 1. After installation, you'll find the 👋Jan application icon on your desktop. Open it. 2. Welcome to the Jan homepage. Click on "Explore Models" to see the Model catalog. -![Explore models](img/explore-model.png) +![Explore models](../img/explore-model.png) 3. You can also see different quantized versions by clicking on "Show Available Versions." -![Model versions](img/model-version.png) +![Model versions](../img/model-version.png) > Note: Choose a model that matches your computer's memory and RAM. 4. Select your preferred model and click "Download." -![Downloading](img/downloading.PNG) +![Downloading](../img/downloading.png) -## Step 3: Start the model +### Step 3: Start the model Once your model is downloaded. Go to "My Models" and then click "Start Model." -![Start model](img/start-model.PNG) +![Start model](../img/start-model.png) -## Step 4: Start the conversations +### Step 4: Start the conversations Now you're ready to start using 👋Jan.ai for conversations: Click "Chat" and begin your first conversation by selecting "New conversation." You can also check the CPU and Memory usage of the computer. -![Chat](img/chat.PNG) +![Chat](../img/chat.png) -That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai. \ No newline at end of file +That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai. + +## Uninstallation + +## Troubleshooting \ No newline at end of file diff --git a/docs/docs/guides/windows.md b/docs/docs/guides/install/windows.md similarity index 77% rename from docs/docs/guides/windows.md rename to docs/docs/guides/install/windows.md index d798f5682..6b13841e7 100644 --- a/docs/docs/guides/windows.md +++ b/docs/docs/guides/install/windows.md @@ -1,16 +1,16 @@ --- -title: Installing Jan on Windows -sidebar_position: 3 +title: Windows --- -# Windows users +# Installing Jan on Windows + ## Step 1: Download the Installer To begin using 👋Jan.ai on your Windows computer, follow these steps: 1. Visit [Jan.ai](https://jan.ai/). 2. Click on the "Download for Windows" button to download the Jan Installer. -![Jan Installer](img/jan-download.png) +![Jan Installer](../img/jan-download.png) ## Step 2: Proceed the Windows Defender @@ -18,11 +18,11 @@ When you run the Jan Installer, Windows Defender may display a warning. Here's w 1. Click "Run away" to accept and install 👋Jan.ai. -![Accept Jan](img/window-defender.png) +![Accept Jan](../img/window-defender.png) -2. Wait for the 👋Jan.ai installation to complete. +1. Wait for the 👋Jan.ai installation to complete. -![Setting up](img/set-up.png) +![Setting up](../img/set-up.png) :::tip @@ -48,22 +48,22 @@ Now, let's get your first model: 2. Welcome to the Jan homepage. Click on "Explore Models" to see the Model catalog. -![Explore models](img/explore-model.png) +![Explore models](../img/explore-model.png) -3. You can also see different quantized versions by clicking on "Show Available Versions." +1. You can also see different quantized versions by clicking on "Show Available Versions." -![Model versions](img/model-version.png) +![Model versions](../img/model-version.png) > Note: Choose a model that matches your computer's memory and RAM. -4. Select your preferred model and click "Download." +1. Select your preferred model and click "Download." -![Downloading](img/downloading.PNG) +![Downloading](../img/downloading.png) ## Step 4: Start the model Once your model is downloaded. Go to "My Models" and then click "Start Model." -![Start model](img/start-model.PNG) +![Start model](../img/start-model.png) ## Step 5: Start the conversations Now you're ready to start using 👋Jan.ai for conversations: @@ -72,6 +72,6 @@ Click "Chat" and begin your first conversation by selecting "New conversation." You can also check the CPU and Memory usage of the computer. -![Chat](img/chat.PNG) +![Chat](../img/chat.png) That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai. \ No newline at end of file diff --git a/docs/docs/guides/concepts.md b/docs/docs/guides/overview.md similarity index 91% rename from docs/docs/guides/concepts.md rename to docs/docs/guides/overview.md index dc4508861..bf44ca685 100644 --- a/docs/docs/guides/concepts.md +++ b/docs/docs/guides/overview.md @@ -1,6 +1,6 @@ --- -title: Concepts -sidebar_position: 1 +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. diff --git a/docs/docs/handbook/engineering/internal.md b/docs/docs/handbook/engineering/engineering.md similarity index 99% rename from docs/docs/handbook/engineering/internal.md rename to docs/docs/handbook/engineering/engineering.md index 6d911671f..e320b25fe 100644 --- a/docs/docs/handbook/engineering/internal.md +++ b/docs/docs/handbook/engineering/engineering.md @@ -1,9 +1,7 @@ --- -title: Cookbook +title: Engineering --- -# Internal Guidelines - ## Connecting to Rigs ### Pritunl Setup diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index d108908c1..7de037430 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -122,13 +122,13 @@ const config = { type: "docSidebar", sidebarId: "guidesSidebar", position: "left", - label: "User Guides", + label: "User Guide", }, { type: "docSidebar", sidebarId: "devSidebar", position: "left", - label: "Developer", + label: "Developers", }, // Navbar right { diff --git a/docs/sidebars.js b/docs/sidebars.js index a260dfee0..13d9c10d6 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -29,23 +29,24 @@ const sidebars = { }, ], - // Autogenerate docs from /guides guidesSidebar: [ + "guides/overview", { type: "category", - label: "Guides", + label: "Installation", collapsible: true, collapsed: true, + link: { type: "doc", id: "guides/install/install" }, items: [ - { - type: "autogenerated", - dirName: "guides", - }, + "guides/install/linux", + "guides/install/windows", + "guides/install/mac", + "guides/install/cloud-native", ], }, + "guides/troubleshooting", ], - // devSidebar: [ { type: "category", @@ -83,53 +84,19 @@ const sidebars = { }, ], }, - // { - // type: "category", - // label: "Tutorials", - // collapsible: true, - // collapsed: false, - // items: [ - // { - // type: "autogenerated", - // dirName: "tutorials", - // }, - // ], - // }, - // { - // type: "category", - // label: "Articles", - // collapsible: true, - // collapsed: false, - // items: [ - // { - // type: "doc", - // label: "Nitro", - // id: "articles/nitro", - // }, - // ], - // }, ], aboutSidebar: [ - // { - // type: "category", - // label: "About Jan", - // collapsible: true, - // collapsed: true, - // link: { type: "doc", id: "about/about" }, - // items: [ - // "about/team", - // { - // type: "link", - // label: "Careers", - // href: "https://janai.bamboohr.com/careers", - // }, - // ], - // }, { type: "doc", + label: "About Jan", id: "about/about", }, + { + type: "link", + label: "Careers", + href: "https://janai.bamboohr.com/careers", + }, { type: "category", label: "Events", @@ -151,9 +118,9 @@ const sidebars = { link: { type: "doc", id: "handbook/handbook" }, items: [ { - type: "category", + type: "doc", label: "Engineering", - items: ["handbook/engineering/internal"], + id: "handbook/engineering/engineering", }, ], },