From e9bd36fbeed92d2f7ecf091310f301c8b7179984 Mon Sep 17 00:00:00 2001 From: Arista Indrajaya Date: Wed, 28 Feb 2024 11:10:43 +0700 Subject: [PATCH] docs: update the content for showing in card --- docs/docs/quickstart/common-error/broken-build.mdx | 4 ++++ docs/docs/quickstart/common-error/not-using-gpu.mdx | 4 ++++ docs/docs/quickstart/error-codes/permission-denied.mdx | 4 ++++ docs/docs/quickstart/error-codes/something-amiss.mdx | 4 ++++ docs/docs/quickstart/error-codes/undefined-issue.mdx | 4 ++++ docs/docs/quickstart/error-codes/unexpected-token.mdx | 4 ++++ docs/docs/quickstart/extensions/import-ext.mdx | 4 ++++ docs/docs/quickstart/extensions/setup-ext.mdx | 4 ++++ docs/docs/quickstart/integration/azure.mdx | 4 ++++ docs/docs/quickstart/integration/discord.mdx | 4 ++++ docs/docs/quickstart/integration/openinterpreter.mdx | 4 ++++ docs/docs/quickstart/integration/openrouter.mdx | 4 ++++ docs/docs/quickstart/integration/raycast.mdx | 4 ++++ docs/docs/quickstart/integration/vscode.mdx | 4 ++++ docs/docs/quickstart/models/customize-engine.mdx | 4 ++++ docs/docs/quickstart/models/import-models.mdx | 3 +++ docs/docs/quickstart/models/integrate-remote.mdx | 4 ++++ 17 files changed, 67 insertions(+) diff --git a/docs/docs/quickstart/common-error/broken-build.mdx b/docs/docs/quickstart/common-error/broken-build.mdx index e79c9058a..2ce4dcaa0 100644 --- a/docs/docs/quickstart/common-error/broken-build.mdx +++ b/docs/docs/quickstart/common-error/broken-build.mdx @@ -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 diff --git a/docs/docs/quickstart/common-error/not-using-gpu.mdx b/docs/docs/quickstart/common-error/not-using-gpu.mdx index 6a979d36c..442793528 100644 --- a/docs/docs/quickstart/common-error/not-using-gpu.mdx +++ b/docs/docs/quickstart/common-error/not-using-gpu.mdx @@ -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 diff --git a/docs/docs/quickstart/error-codes/permission-denied.mdx b/docs/docs/quickstart/error-codes/permission-denied.mdx index dfc9e4c73..0b2c2329e 100644 --- a/docs/docs/quickstart/error-codes/permission-denied.mdx +++ b/docs/docs/quickstart/error-codes/permission-denied.mdx @@ -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: ``` diff --git a/docs/docs/quickstart/error-codes/something-amiss.mdx b/docs/docs/quickstart/error-codes/something-amiss.mdx index 995e92093..dfeaeedcd 100644 --- a/docs/docs/quickstart/error-codes/something-amiss.mdx +++ b/docs/docs/quickstart/error-codes/something-amiss.mdx @@ -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. diff --git a/docs/docs/quickstart/error-codes/undefined-issue.mdx b/docs/docs/quickstart/error-codes/undefined-issue.mdx index 1eabc0978..686ac1df0 100644 --- a/docs/docs/quickstart/error-codes/undefined-issue.mdx +++ b/docs/docs/quickstart/error-codes/undefined-issue.mdx @@ -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 diff --git a/docs/docs/quickstart/error-codes/unexpected-token.mdx b/docs/docs/quickstart/error-codes/unexpected-token.mdx index 1b6d9dca1..f152f9807 100644 --- a/docs/docs/quickstart/error-codes/unexpected-token.mdx +++ b/docs/docs/quickstart/error-codes/unexpected-token.mdx @@ -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 '<', " **Extensions** > Click Select under **Manual Installation**. diff --git a/docs/docs/quickstart/extensions/setup-ext.mdx b/docs/docs/quickstart/extensions/setup-ext.mdx index ca301340a..59025a8d9 100644 --- a/docs/docs/quickstart/extensions/setup-ext.mdx +++ b/docs/docs/quickstart/extensions/setup-ext.mdx @@ -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 diff --git a/docs/docs/quickstart/integration/azure.mdx b/docs/docs/quickstart/integration/azure.mdx index c5c0e570a..52af9fe1d 100644 --- a/docs/docs/quickstart/integration/azure.mdx +++ b/docs/docs/quickstart/integration/azure.mdx @@ -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. diff --git a/docs/docs/quickstart/integration/discord.mdx b/docs/docs/quickstart/integration/discord.mdx index 2f1fec7fe..900413784 100644 --- a/docs/docs/quickstart/integration/discord.mdx +++ b/docs/docs/quickstart/integration/discord.mdx @@ -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. diff --git a/docs/docs/quickstart/integration/openinterpreter.mdx b/docs/docs/quickstart/integration/openinterpreter.mdx index e427adc5b..45cff58b5 100644 --- a/docs/docs/quickstart/integration/openinterpreter.mdx +++ b/docs/docs/quickstart/integration/openinterpreter.mdx @@ -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. diff --git a/docs/docs/quickstart/integration/openrouter.mdx b/docs/docs/quickstart/integration/openrouter.mdx index b3c7c7a5a..8e75cbe1d 100644 --- a/docs/docs/quickstart/integration/openrouter.mdx +++ b/docs/docs/quickstart/integration/openrouter.mdx @@ -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. diff --git a/docs/docs/quickstart/integration/raycast.mdx b/docs/docs/quickstart/integration/raycast.mdx index d040f8c57..8d572b85c 100644 --- a/docs/docs/quickstart/integration/raycast.mdx +++ b/docs/docs/quickstart/integration/raycast.mdx @@ -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. diff --git a/docs/docs/quickstart/integration/vscode.mdx b/docs/docs/quickstart/integration/vscode.mdx index 74f3ce367..bde2697f0 100644 --- a/docs/docs/quickstart/integration/vscode.mdx +++ b/docs/docs/quickstart/integration/vscode.mdx @@ -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). diff --git a/docs/docs/quickstart/models/customize-engine.mdx b/docs/docs/quickstart/models/customize-engine.mdx index d56fde2d8..8c571d2b1 100644 --- a/docs/docs/quickstart/models/customize-engine.mdx +++ b/docs/docs/quickstart/models/customize-engine.mdx @@ -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. diff --git a/docs/docs/quickstart/models/import-models.mdx b/docs/docs/quickstart/models/import-models.mdx index ec38b0790..899ea03ca 100644 --- a/docs/docs/quickstart/models/import-models.mdx +++ b/docs/docs/quickstart/models/import-models.mdx @@ -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. diff --git a/docs/docs/quickstart/models/integrate-remote.mdx b/docs/docs/quickstart/models/integrate-remote.mdx index e56196c6a..510d34701 100644 --- a/docs/docs/quickstart/models/integrate-remote.mdx +++ b/docs/docs/quickstart/models/integrate-remote.mdx @@ -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.