docs: update the content for showing in card

This commit is contained in:
Arista Indrajaya 2024-02-28 11:10:43 +07:00
parent 67cfb838b2
commit e9bd36fbee
17 changed files with 67 additions and 0 deletions

View File

@ -8,6 +8,10 @@ import TabItem from '@theme/TabItem';
# Broken Build
A step-by-step guide to fix errors that prevent the project from compiling or running successfully.
---
The `Broken Build` issue is caused by Jan's unstable build after installation. To resolve solve it, follow the following steps
<Tabs>

View File

@ -7,6 +7,10 @@ import openDirectory from "./assets/janOpenAppDirectory.gif";
# Jan not using GPU
A step-by-step guide to enable Jan to properly leverage GPU resources, avoiding performance issues.
---
The `Jan not using GPU` issue is caused due to Jan app does not utilize the GPU on Windows and Linux systems.
### GPU Mode Requirements for Windows and Linux

View File

@ -4,6 +4,10 @@ sidebar_position: 1
# Permission Denied
A step-by-step guide to fix the issue when access is denied due to insufficient permissions.
---
When running Jan, you might encounter the following error message:
```

View File

@ -7,6 +7,10 @@ import TabItem from '@theme/TabItem';
# Something's Amiss
A step-by-step guide to resolve an unspecified or general error.
---
When you start a chat with a model and encounter with a Something's Amiss error, here's how to resolve it:
1. Ensure your OS is up to date.
2. Choose a model smaller than 80% of your hardware's V/RAM. For example, on an 8GB machine, opt for models smaller than 6GB.

View File

@ -4,6 +4,10 @@ sidebar_position: 3
# Undefined Issue
A step-by-step guide to resolve errors when a variable or object is not defined.
---
Encountering an "undefined" issue in Jan is caused by errors related to the Nitro tool or other internal processes. It can be resolved through the following steps:
1. Clearing the Jan folder and then reopen the application to determine if the problem persists

View File

@ -4,6 +4,10 @@ sidebar_position: 2
# Unexpected Token
A step-by-step guide to correct syntax errors caused by an unexpected symbol in the code.
---
Encountering the error `Unexpected token '<', "<!DOCTYPE"...is not valid JSON` when initiating a chat with OpenAI models can be addressed through the following steps:
1. Obtain an OpenAI API key from [OpenAI's developer platform](https://platform.openai.com/) and integrate it into your application.

View File

@ -6,6 +6,10 @@ import extensionsURL from './assets/jan-ai-extensions.png';
# Import Extensions
A step-by-step guide on how to import extensions.
---
Besides default extensions, you can import extensions into Jan by following the steps below:
1. Navigate to **Settings** > **Extensions** > Click Select under **Manual Installation**.

View File

@ -6,6 +6,10 @@ import janExtensionSetup from './assets/extension-setup.png';
# Extension Setup
Dive into the available extensions and configure them.
---
The current Jan Desktop Client has some default extensions built on top of this framework to enhance the user experience. In this guide, we will show you the list of default extensions and how to configure extension settings.
## Default Extensions

View File

@ -6,6 +6,10 @@ import azure from './assets/azure.png';
# Azure OpenAI
A step-by-step guide on how to integrate Jan with Azure OpenAI.
---
## Overview
This guide will show you how to integrate Azure OpenAI Service with Jan. The [Azure OpenAI Service](https://learn.microsoft.com/en-us/azure/ai-services/openai/overview?source=docs) offers robust APIs, making it simple for you to incorporate OpenAI's language models into your applications.

View File

@ -6,6 +6,10 @@ import discord_repo from './assets/jan-ai-discord-repo.png';
# Discord
A step-by-step guide on how to integrate Jan with a Discord bot.
---
## Overview
This tutorial demonstrates the process of integrating with a Discord bot using Jan.

View File

@ -4,6 +4,10 @@ sidebar_position: 6
# Open Interpreter
A step-by-step guide on how to integrate Jan with Open Interpreter.
---
## Overview
This tutorial illustrates how to integrate with Open Interpreter using Jan. [Open Interpreter](https://github.com/KillianLucas/open-interpreter/) lets LLMs run code (Python, Javascript, Shell, and more) locally. You can chat with Open Interpreter through a ChatGPT-like interface in your terminal by running `interpreter` after installing.

View File

@ -7,6 +7,10 @@ import openrouter from './assets/openrouter.png';
# OpenRouter
A step-by-step guide on how to integrate Jan with OpenRouter.
---
## Overview
This guide will show you how to integrate OpenRouter with Jan, allowing you to utilize remote LLMs accessible through OpenRouter. [OpenRouter](https://openrouter.ai/docs#quick-start) is a tool that gathers AI models. Developers can utilize its API to engage with diverse large language models, generative image models, and generative 3D object models.

View File

@ -7,6 +7,10 @@ import raycastImage from './assets/raycast-image.png';
# Raycast
A step-by-step guide on how to integrate Jan with Raycast.
---
## Overview
[Raycast](https://www.raycast.com/) is a productivity tool designed for macOS that enhances workflow efficiency by providing quick access to various tasks and functionalities through a keyboard-driven interface.

View File

@ -9,6 +9,10 @@ import TabItem from '@theme/TabItem';
# Continue Integration for Visual Studio Code
A step-by-step guide on how to integrate Jan with Continue and VS Code.
---
## Overview
This guide showcases integrating Continue with Jan and VS Code to boost your coding using the local AI language model's features. [Continue](https://continue.dev/docs/intro) is an open-source autopilot compatible with Visual Studio Code and JetBrains, offering the simplest method to code with any LLM (Local Language Model).

View File

@ -7,6 +7,10 @@ import TabItem from '@theme/TabItem';
# Customize Engine Settings
A step-by-step guide to change your engine's settings.
---
In this guide, we'll walk you through the process of customizing your engine settings by tweaking the `nitro.json` file
1. Navigate to the `App Settings` > `Advanced` > `Open App Directory` > `~/jan/engine` folder.

View File

@ -8,6 +8,9 @@ import janModel from './assets/jan-model-hub.png';
# Manual Import
A step-by-step guide on how to perform manual import feature.
---
:::warning
This is currently under development.

View File

@ -4,6 +4,10 @@ sidebar_position: 2
# Remote Server Integration
A step-by-step guide on how to set up Jan to connect with any remote or local API server.
---
:::warning
This is currently under development.