Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update content for Hub page and Guides section #2245

Merged
merged 9 commits into from
Mar 5, 2024
22 changes: 22 additions & 0 deletions docs/docs/guides/advanced-settings/advanced-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,26 @@ Here are some of the keyboard shortcuts that you can use in Jan.
| `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) |

</TabItem>
<TabItem value="linux" label = "Linux" default>
| 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 previous option (within search dialog) |
| `Arrow Down` | Navigate to next option (within search dialog) |

</TabItem>
</Tabs>
:::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:
Expand Down Expand Up @@ -115,13 +131,19 @@ 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 clear 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**.
4. On the **Clear Logs** click the the **Clear** button.

## 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**.
Expand Down
10 changes: 8 additions & 2 deletions docs/docs/guides/advanced-settings/http-proxy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ keywords:
## Why HTTPS Proxy?

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
Using an HTTPS proxy will affect your model's performance
henryh0x1 marked this conversation as resolved.
Show resolved Hide resolved
:::
## 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.

Expand All @@ -31,7 +33,11 @@ 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.

Expand Down
48 changes: 48 additions & 0 deletions docs/docs/guides/best-practices.mdx
Original file line number Diff line number Diff line change
@@ -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
16 changes: 9 additions & 7 deletions docs/docs/guides/common-error/not-using-gpu.mdx
Original file line number Diff line number Diff line change
@@ -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,
Expand All @@ -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

Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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

Expand Down
14 changes: 7 additions & 7 deletions docs/src/components/HomepagePrimaryFeatures/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@ export default function HomepagePrimaryFeatures() {
return (
<section className="py-8 md:py-16 lg:py-20 flex items-center">
<div className="container">
<div className="flex flex-col md:flex-row justify-center md:gap-8">
<div className="flex flex-col md:flex-row justify-between md:gap-8">
<div className="w-full md:w-1/2 h-72 md:h-84 flex-1 rounded-lg p-8 relative bg-gradient-to-r from-gray-100 to-blue-400 dark:from-gray-700 dark:to-blue-800 mb-8 md:mb-0">
<div className="mb-10">
<div className="mb-16">
<p className="text-lg mb-4">Installation</p>
<h3 className="text-2xl md:text-3xl lg:text-4xl font-semibold">Set up Jan with our guide to install across multiple platforms.</h3>
<h3 className="text-1xl md:text-2xl lg:text-3xl font-semibold">Install Jan across multiple platforms.</h3>
</div>
<div>
<a href={"/guides/install"} className="btn bg-black hover:bg-gray-600 dark:bg-blue-500 text-white font-normal py-2 px-4 rounded-xl">Get Started</a>
<a href={"/guides/install"} className="btn bg-black hover:bg-gray-600 dark:bg-blue-500 text-normal md:text-xl text-white font-normal py-2 px-4 rounded-xl">Get Started</a>
</div>
<div className="absolute right-4 bottom-4">
<img alt={"Card Image"} src={"/img/homepage-new/rocket.png"} className="h-16 md:h-24" />
</div>
</div>
<div className="w-full md:w-1/2 h-72 md:h-84 flex-1 rounded-lg p-8 relative bg-gradient-to-r from-gray-100 to-purple-400 dark:from-gray-700 dark:to-purple-800">
<div className="mb-10">
<div className="mb-8">
<p className="text-lg mb-4">Models</p>
<h3 className="text-2xl md:text-3xl lg:text-4xl font-semibold">Explore the available pre-configured AI models.</h3>
<h3 className="text-1xl md:text-2xl lg:text-3xl font-semibold">Discover the pre-configured AI models available for use. </h3>
</div>
<div>
<a href={"/guides/models-list"} className="btn bg-black hover:bg-gray-600 dark:bg-blue-500 text-white font-normal py-2 px-4 rounded-xl">Support</a>
<a href={"/guides/models-list"} className="btn bg-black hover:bg-gray-600 dark:bg-blue-500 text-normal md:text-xl text-white font-normal py-2 px-4 rounded-xl">Support</a>
</div>
<div className="absolute right-4 bottom-4">
<img alt={"Card Image"} src={"/img/homepage-new/chat.png"} className="h-16 md:h-24" />
Expand Down
6 changes: 3 additions & 3 deletions docs/src/components/HomepageSecondaryFeatures/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ export default function HomepageSecondaryFeatures() {
<FeatureCard
imgSrc="/img/homepage-new/bg-rocket.png"
title="Quickstart"
description="Jump right in with our Quickstart guide, designed to get you going with simple steps and clear instructions for a smooth setup."
description="Get started quickly with our Quickstart guide, offering simple steps for a smooth setup."
href="/guides/"
/>
<FeatureCard
imgSrc="/img/homepage-new/bg-wrench.png"
title="Integrations"
description="Discover how Jan seamlessly integrates with 9 different systems, streamlining your application for maximum efficiency."
description="Learn how Jan can integrates seamlessly."
href="/guides/integrations/"
/>
<FeatureCard
imgSrc="/img/homepage-new/bg-book.png"
title="Error Codes"
description="Navigate through common error codes with explanations and solutions to resolve them quickly."
description="Find solutions for common error codes to resolve them quickly."
href="/guides/error-codes/"
/>
</div>
Expand Down
10 changes: 5 additions & 5 deletions docs/src/components/HomepageTerinaryFeatures/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ export default function HomepageTerinaryFeatures() {
<div className="bg-gray-200 dark:bg-gray-800 w-72 rounded-lg relative flex flex-col p-8">
<div className="flex items-center gap-4">
<img alt={"Icon"} src={"/img/homepage-new/roket.png"} />
<h3 className="text-gray-700 dark:text-gray-200">Get Started</h3>
<h5 className="text-gray-700 dark:text-gray-200">Get Started</h5>
</div>
<div className="mt-5 justify-center">
<p className="text-gray-700 dark:text-gray-200">Kick off your journey with Jan easily and install your AI locally.</p>
<p className="text-gray-700 dark:text-gray-200">Easily kick off your journey with Jan by installing your AI locally.</p>
<ul className="mt-5">
<li className="font-semibold list-disc mb-4">
<a href={"/guides/"} className=" dark:text-blue-400">
Expand All @@ -35,7 +35,7 @@ export default function HomepageTerinaryFeatures() {
<h5 className="text-gray-700 dark:text-gray-200">Settings</h5>
</div>
<div className="mt-5 justify-center">
<p className="text-gray-700 dark:text-gray-200">Learn how to manage the thread history and configure your installed AI.</p>
<p className="text-gray-700 dark:text-gray-200">Discover how to manage Jan and configure your installed AI.</p>
<ul className="mt-5">
<li className="font-semibold list-disc mb-4">
<a href={"/guides/thread/"} className="dark:text-blue-400">
Expand All @@ -61,7 +61,7 @@ export default function HomepageTerinaryFeatures() {
<h5 className="text-gray-700 dark:text-gray-200">Features</h5>
</div>
<div className="mt-5 justify-center">
<p className="text-gray-700 dark:text-gray-200">Explore our key features designed to enhance your experience.</p>
<p className="text-gray-700 dark:text-gray-200">Explore key features designed to enhance your experience with Jan.</p>
<ul className="mt-5">
<li className="font-semibold list-disc mb-4">
<a href={"/guides/models-setup/"} className="dark:text-blue-400">
Expand Down Expand Up @@ -111,4 +111,4 @@ export default function HomepageTerinaryFeatures() {
</div>
</section>
);
}
}
4 changes: 2 additions & 2 deletions docs/src/theme/NavbarExtension/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export default function NavBarExtension() {
const location = useLocation();

return (
<nav className="bg-white dark:bg-gray-800 h-12 px-10 pt-3 flex items-center justify-between fixed top-14 left-0 w-full z-10 hidden md:block">
<nav className="bg-white dark:bg-gray-800 h-12 px-10 pt-3 flex items-center justify-between fixed top-14 left-0 w-full z-50 hidden md:block">
<div className="flex items-center space-x-16">
<NavLink
to="/docs"
Expand Down Expand Up @@ -40,7 +40,7 @@ export default function NavBarExtension() {
className="text-gray-700 font-medium hover:text-gray-900 dark:text-gray-300 dark:hover:text-gray-200"
activeClassName={location.pathname === "/guides/changelog" ? "text-gray-900 dark:text-gray-100 font-semibold border-b-2 border-gray-900 dark:border-gray-100" : ""}
>
Changelogs
Changelog
</NavLink>
</div>
</nav>
Expand Down
Loading