diff --git a/docs/docs/guides/advanced-settings/advanced-settings.mdx b/docs/docs/guides/advanced-settings/advanced-settings.mdx index 14dfd8cb3..ae3244cda 100644 --- a/docs/docs/guides/advanced-settings/advanced-settings.mdx +++ b/docs/docs/guides/advanced-settings/advanced-settings.mdx @@ -53,24 +53,40 @@ Here are some of the keyboard shortcuts that you can use in Jan. | `⌘ ,` | Navigate to setting page | | `Enter` | Send a message | | `Shift + Enter` | Insert new line in input box | -| `Arrow Up` | Navigate to previous option (within search dialog) | -| `Arrow Down` | Navigate to next option (within search dialog) | +| `Arrow Up` | Navigate to the previous option (within the search dialog) | +| `Arrow Down` | Navigate to the next option (within the search dialog) | | Combination | Description | | --------------- | -------------------------------------------------- | -| `Ctrl E` | Show list your models | -| `Ctrl K` | Show list navigation pages | -| `Ctrl B` | Toggle collapsible left panel | -| `Ctrl ,` | Navigate to setting page | +| `Ctrl E` | Show list your models | +| `Ctrl K` | Show list navigation pages | +| `Ctrl B` | Toggle collapsible left panel | +| `Ctrl ,` | Navigate to setting page | | `Enter` | Send a message | | `Shift + Enter` | Insert new line in input box | -| `Arrow Up` | Navigate to previous option (within search dialog) | -| `Arrow Down` | Navigate to next option (within search dialog) | +| `Arrow Up` | Navigate to the previous option (within the search dialog) | +| `Arrow Down` | Navigate to the next option (within the search dialog) | + + + +| Combination | Description | +| --------------- | -------------------------------------------------- | +| `Ctrl E` | Show list your models | +| `Ctrl K` | Show list navigation pages | +| `Ctrl B` | Toggle collapsible left panel | +| `Ctrl ,` | Navigate to setting page | +| `Enter` | Send a message | +| `Shift + Enter` | Insert new line in input box | +| `Arrow Up` | Navigate to the previous option (within the search dialog) | +| `Arrow Down` | Navigate to the next option (within the search dialog) | +:::note +The keyboard shortcuts are customizable. +::: ## Enable the Experimental Mode To try out new fetures that are still in testing phase, follow the steps below: @@ -91,7 +107,7 @@ Ensure that you have read the [troubleshooting guide](/docs/guides/common-error/ 4. On the **GPU Acceleration** click the slider to enable. ## Access the Jan Data Folder -To access the folder where messages, model configurtions and user data stored follow the steps below: +To access the folder where messages, model configurations and user data are stored, follow the steps below: 1. Navigate to the main dashboard. 2. Click the **gear icon (⚙️)** on the bottom left of your screen. 3. Under the **Settings screen**, click the **Advanced Settings**. @@ -115,6 +131,9 @@ To Allow self-signed or unverified certificates, follow the steps below: ## Clear Logs To clear all logs on your Jan app, follow the steps below: +:::warning +This feature clears all the data in your **Jan Data Folder**. +::: 1. Navigate to the main dashboard. 2. Click the **gear icon (⚙️)** on the bottom left of your screen. 3. Under the **Settings screen**, click the **Advanced Settings**. @@ -122,6 +141,9 @@ To clear all logs on your Jan app, follow the steps below: ## Reset To Factory Default To reset the Jan app to its original state, follow the steps below: +:::danger[Remember!] +This irreversible action is only recommended if the application is corrupted. +::: 1. Navigate to the main dashboard. 2. Click the **gear icon (⚙️)** on the bottom left of your screen. 3. Under the **Settings screen**, click the **Advanced Settings**. diff --git a/docs/docs/guides/advanced-settings/http-proxy.mdx b/docs/docs/guides/advanced-settings/http-proxy.mdx index ded6da055..23f357e8b 100644 --- a/docs/docs/guides/advanced-settings/http-proxy.mdx +++ b/docs/docs/guides/advanced-settings/http-proxy.mdx @@ -21,6 +21,12 @@ keywords: HTTPS Proxy encrypts data between your browser and the internet, making it hard for outsiders to intercept or read. It also helps you to maintain your privacy and security while being able to bypass regional restrictions on internet. +:::note + +When configuring Jan using an HTTPS proxy, the speed of the downloading model may be affected due to the encryption and decryption process. It also depends on the networking of the cloud service provider. + +::: + ## Setting Up Your Own HTTPS Proxy Server This guide provides a simple overview of setting up an HTTPS proxy server using **Squid**, a widely used open-source proxy software. @@ -31,8 +37,13 @@ Other software options are also available depending on your requirements. ### Step 1: Choosing a Server 1. Firstly, you need to choose a server to host your proxy server. :::note -We recommend using a cloud provider like Amazon AWS, Google Cloud, Microsoft Azure, Digital Ocean, etc. +We recommend using a well-known cloud provider service like: +- Amazon AWS +- Google Cloud +- Microsoft Azure +- Digital Ocean ::: + 2. Ensure that your server has a public IP address and is accessible from the internet. ### Step 2: Installing Squid diff --git a/docs/docs/guides/best-practices.mdx b/docs/docs/guides/best-practices.mdx new file mode 100644 index 000000000..c3cdacb69 --- /dev/null +++ b/docs/docs/guides/best-practices.mdx @@ -0,0 +1,48 @@ +--- +title: Best Practices +sidebar_position: 3 +description: Comprehensive set of best practices. +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + acknowledgements, + third-party libraries, + ] +--- + +Jan is a versatile platform offering solutions for integrating AI locally across various platforms. This guide outlines best practices for developers, analysts, and AI enthusiasts to enhance their experience with Jan when adding AI locally to their computers. Implementing these practices will optimize the performance of AI models. + +## Follow the Quickstart Guide +The [quickstart guide](quickstart.mdx) is designed to facilitate a quick setup process. It provides a clear instruction and simple steps to get you up and running with Jan.ai quickly. Even, if you are inexperienced in AI, the quickstart can offer valuable insights and tips to help you get started quickly. + +## Setting up the Right Models +Jan offers a range of pre-configured AI models that is tailored to different tasks and industries. You should indentify which on that aligns with your objectives. There are model's factors to be considered: +- Capabilities +- Accuracy +- Processing Speed + +:::note +Some of these factors also depends on your hardware, please see [Hardware Requirement](hardware-requiement.mdx). +::: +Choosing the right model is important to achieve the best performance. + +## Setting up Jan +Ensure that you familiarize yourself with the Jan application. Jan offers advanced settings that you can adjust. These settings may influence how your AI behaves locally. Please see the [Advanced Settings](./advanced-settings/advanced-settings.mdx) article for a complete list of Jan's configurations and instructions on how to configure them. + +## Integrations +One of Jan.ai key features is its ability to integrate with many FileSystemWritableFileStream. Whether you are incorporating Jan.ai with any open-source LLM provider or other WebTransportBidirectionalStream, it is important to understand the integration capabilities and limitations. + +## Mastering the Prompt Engineering +Prompt engineering is an important aspect when dealing with AI models to generate the desired outputs. Mastering this skill can significantly enhance the performance and the responses of the AI. Below are some tips that you can do for promptengineering: +- Ask the model to adopt a persona +- Be specific and details get a more specific answers +- Provide examples or preference text or context at the beginning +- Use a clear and concise language +- Use a certain keywords and phrases diff --git a/docs/docs/guides/common-error/not-using-gpu.mdx b/docs/docs/guides/common-error/not-using-gpu.mdx index f8a9e1ad4..a7dd788f8 100644 --- a/docs/docs/guides/common-error/not-using-gpu.mdx +++ b/docs/docs/guides/common-error/not-using-gpu.mdx @@ -1,7 +1,7 @@ --- -title: Jan not using GPU +title: Troubleshooting NVIDIA GPU sidebar_position: 2 -description: A step-by-step guide to enable Jan to properly leverage GPU resources, avoiding performance issues. +description: A step-by-step guide to enable Jan to properly leverage NVIDIA GPU resources, avoiding performance issues. keywords: [ Jan AI, Jan, @@ -21,7 +21,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -This guide provides steps to troubleshoot and resolve issues when the Jan app does not utilize the GPU on Windows and Linux systems. +This guide provides steps to troubleshoot and resolve issues when the Jan app does not utilize the NVIDIA GPU on Windows and Linux systems. ### 1. Ensure GPU Mode Requirements @@ -30,7 +30,7 @@ This guide provides steps to troubleshoot and resolve issues when the Jan app do #### NVIDIA Driver - - Install an NVIDIA driver supporting CUDA 11.7 or higher. + - Install an [NVIDIA Driver](https://www.nvidia.com/Download/index.aspx) supporting CUDA 11.7 or higher. - Use the following command to verify the installation: ```sh @@ -39,7 +39,7 @@ This guide provides steps to troubleshoot and resolve issues when the Jan app do #### CUDA Toolkit - - Install a CUDA toolkit compatible with your NVIDIA driver. + - Install a [CUDA toolkit](https://developer.nvidia.com/cuda-downloads) compatible with your NVIDIA driver. - Use the following command to verify the installation: ```sh @@ -51,7 +51,7 @@ This guide provides steps to troubleshoot and resolve issues when the Jan app do #### NVIDIA Driver - - Install an NVIDIA driver supporting CUDA 11.7 or higher. + - Install an [NVIDIA Driver](https://www.nvidia.com/Download/index.aspx) supporting CUDA 11.7 or higher. - Use the following command to verify the installation: ```sh @@ -60,7 +60,7 @@ This guide provides steps to troubleshoot and resolve issues when the Jan app do #### CUDA Toolkit - - Install a CUDA toolkit compatible with your NVIDIA driver. + - Install a [CUDA toolkit](https://developer.nvidia.com/cuda-downloads) compatible with your NVIDIA driver. - Use the following command to verify the installation: ```sh @@ -123,6 +123,8 @@ If GPU mode isn't enabled by default: "gpu_highest_vram": "0" } ``` +### 4. Restart Jan +Restart Jan application to make sure it works. #### Troubleshooting Tips diff --git a/docs/src/components/HomepagePrimaryFeatures/index.js b/docs/src/components/HomepagePrimaryFeatures/index.js index e139ae358..a9762c4e5 100644 --- a/docs/src/components/HomepagePrimaryFeatures/index.js +++ b/docs/src/components/HomepagePrimaryFeatures/index.js @@ -2,26 +2,26 @@ export default function HomepagePrimaryFeatures() { return (
-
+
-
+

Installation

-

Set up Jan with our guide to install across multiple platforms.

+

Install Jan across multiple platforms.

{"Card
-
+

Models

-

Explore the available pre-configured AI models.

+

Discover the pre-configured AI models available for use.

{"Card diff --git a/docs/src/components/HomepageSecondaryFeatures/index.js b/docs/src/components/HomepageSecondaryFeatures/index.js index 9c8307c3f..37bac0a13 100644 --- a/docs/src/components/HomepageSecondaryFeatures/index.js +++ b/docs/src/components/HomepageSecondaryFeatures/index.js @@ -1,4 +1,4 @@ -import React from "react"; +import React from 'react' export default function HomepageSecondaryFeatures() { return ( @@ -8,25 +8,25 @@ export default function HomepageSecondaryFeatures() {
- ); + ) } function FeatureCard({ imgSrc, title, description, href }) { @@ -34,7 +34,7 @@ function FeatureCard({ imgSrc, title, description, href }) {
- {"Feature + {'Feature

{title}

@@ -42,10 +42,13 @@ function FeatureCard({ imgSrc, title, description, href }) {
- - Learn Here + + Learn more
- ); + ) } diff --git a/docs/src/components/HomepageTerinaryFeatures/index.js b/docs/src/components/HomepageTerinaryFeatures/index.js index 025bab0ca..ec959332e 100644 --- a/docs/src/components/HomepageTerinaryFeatures/index.js +++ b/docs/src/components/HomepageTerinaryFeatures/index.js @@ -6,10 +6,10 @@ export default function HomepageTerinaryFeatures() {
{"Icon"} -

Get Started

+
Get Started
-

Kick off your journey with Jan easily and install your AI locally.

+

Easily kick off your journey with Jan by installing your AI locally.

-

Learn how to manage the thread history and configure your installed AI.

+

Discover how to manage Jan and configure your installed AI.

-

Explore our key features designed to enhance your experience.

+

Explore key features designed to enhance your experience with Jan.

); -} +} \ No newline at end of file diff --git a/docs/src/theme/NavbarExtension/index.js b/docs/src/theme/NavbarExtension/index.js index 29e49f812..2c40c1504 100644 --- a/docs/src/theme/NavbarExtension/index.js +++ b/docs/src/theme/NavbarExtension/index.js @@ -5,7 +5,7 @@ export default function NavBarExtension() { const location = useLocation(); return ( -