Skip to content
This repository has been archived by the owner on Oct 14, 2024. It is now read-only.

Commit

Permalink
Merge branch 'main' of https://github.com/janhq/docs into 0.6.0-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
irfanpena committed Aug 29, 2024
2 parents 85048e0 + d7b1a21 commit a335520
Show file tree
Hide file tree
Showing 18 changed files with 102 additions and 23 deletions.
2 changes: 1 addition & 1 deletion src/components/Home/APIStructure/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ const APIStructure = () => {
<div className="w-full lg:w-1/2 mx-auto text-center my-8">
<a
className="text-black dark:text-white bg-[#F0F0F0] dark:bg-[#242424] cursor-pointer font-bold py-3 px-5 rounded-lg border border-ragy-200 dark:border-neutral-700"
href="/api-reference/"
href="https://cortex.so/api-reference"
target="_blank"
>
API Reference
Expand Down
7 changes: 6 additions & 1 deletion src/pages/docs/data-folder.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To open the Jan data folder from the app:
2. Click the App Log button.
3. This redirects you to the Jan data folder.

```
```bash
# Windows
~/AppData/Roaming/Jan/data

Expand Down Expand Up @@ -82,6 +82,11 @@ Jan is stored in the root `~/jan` by default.
/joi-dark
/joi-light
/night-blue
/themes
/dark-dimmed
/joi-dark
/joi-light
/night-blue
/threads
/jan_thread_A
messages.jsonl
Expand Down
19 changes: 11 additions & 8 deletions src/pages/docs/desktop/linux.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -266,10 +266,13 @@ To uninstall Jan, follow the steps below:
sudo apt-get remove jan

# Remove the Jan data folder
rm -rf jan
rm -rf Jan

# Delete the application data and cache
rm -rf ~/.cache/jan
# Delete the application data
rm -rf ~/.config/Jan/data

# Delete the application cache
rm -rf ~/.config/Jan/cache
```
</Tabs.Tab>
<Tabs.Tab>
Expand All @@ -279,11 +282,11 @@ rm -rf ~/.cache/jan
# Uninstall Jan
sudo dnf remove jan

# Remove the Jan data folder
rm -rf jan
# Delete the application data
rm -rf ~/.config/Jan/data

# Delete the application data and cache
rm -rf ~/.cache/jan
# Delete the application cache
rm -rf ~/.config/Jan/cache
```
</Tabs.Tab>
</Tabs>
Expand Down Expand Up @@ -314,7 +317,7 @@ Yes, `.AppImage` is designed to be distribution-agnostic, meaning it can run on
No, `.deb` files are specifically intended for Debian-based distributions and may not be compatible with other Linux distributions.
</FAQBox>
<Callout type="info">
Warning: If you have any trouble during installation, please see our [Troubleshooting](https://www.notion.so/docs/troubleshooting) guide to resolve your problem.
Warning: If you have any trouble during installation, please see our [Troubleshooting](/docs/troubleshooting) guide to resolve your problem.
</Callout>
*/}
2 changes: 1 addition & 1 deletion src/pages/docs/desktop/mac.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -184,4 +184,4 @@ No, it cannot be restored once you delete the Jan data folder during uninstallat
💡 Warning: If you have any trouble during installation, please see our [Troubleshooting](/docs/troubleshooting) guide to resolve your problem.
</Callout>
*/}
*/}
6 changes: 4 additions & 2 deletions src/pages/docs/desktop/windows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,9 @@ To uninstall Jan, follow the steps below:
4. Click **OK**.
5. A message will appear: **"Do you also want to delete the DEFAULT Jan data folder at C:\Users\{username}\Jan?"**.
6. Click **OK** to delete the entire Jan data folder, or click **Cancel** to save your Jan Data folder so you can use this on the new installation folder.
7. Navigate to `users/{username}/AppData/Roaming`.
8. Delete the `Jan` folder that contains the app cache.

<Callout type="warning">
The deleted Data Folder cannot be restored.
</Callout>
Expand All @@ -210,5 +213,4 @@ No, it cannot be restored once you delete the Jan data folder during uninstallat
<Callout type="warning">
If you have any trouble during installation, please see our [Troubleshooting](https://www.notion.so/docs/troubleshooting) guide to resolve your problem.
</Callout>
*/}
</Callout> */}
1 change: 1 addition & 0 deletions src/pages/docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ keywords:
import { Tabs } from 'nextra/components'
import { Callout, Steps } from 'nextra/components'


# Quickstart
<Steps>

Expand Down
7 changes: 6 additions & 1 deletion src/pages/docs/remote-models/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
},
"azure": {
"title": "Azure OpenAI API",
"href": "/docs/remote-models/azure"
"href": "/docs/remote-models/azure",
"display": "hidden"
},
"groq": { "title": "Groq API", "href": "/docs/remote-models/groq" },
"mistralai": {
Expand All @@ -29,5 +30,9 @@
"nvidia-nim": {
"title": "NVIDIA NIM API",
"href": "/docs/remote-models/nvidia-nim"
},
"triton": {
"title": "Triton-TRT-LLM",
"href": "/docs/remote-models/triton"
}
}
2 changes: 1 addition & 1 deletion src/pages/docs/remote-models/anthropic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Before proceeding, ensure you have the following:
3. There are three ways to configure your API Key in Jan app:
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **My Models** tab > **Add Icon (➕)** next to **Anthropic**.
- Navigate to the **Jan app** > **Thread** > **Model** tab > **Add Icon (➕)** next to **Anthropic**.
- Navigate to the **Jan app** > **Model Hub** > *Cloud** tab > **Set Up** next to **Anthropic**.
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **Anthropic** section under Model Providers.
4. Insert your **Anthropic API Key**.

### Step 2: Start Chatting with the Model
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/remote-models/azure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This guide provides step-by-step instructions for integrating the Azure OpenAI A
3. There are three ways to configure your API Key in Jan app:
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **My Models** tab > **Add Icon (➕)** next to **OpenAI**.
- Navigate to the **Jan app** > **Thread** > **Model** tab > **Add Icon (➕)** next to **OpenAI**.
- Navigate to the **Jan app** > **Model Hub** > *Cloud** tab > **Gear Icon (⚙️)** next to **OpenAI**.
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **OpenAI** section under Model Providers.
4. Insert your **OpenAI API Key**.

<Callout type='info'>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/remote-models/cohere.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Before proceeding, ensure you have the following:
3. There are three ways to configure your API Key in Jan app:
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **My Models** tab > **Add Icon (➕)** next to **Cohere**.
- Navigate to the **Jan app** > **Thread** > **Model** tab > **Add Icon (➕)** next to **Cohere**.
- Navigate to the **Jan app** > **Model Hub** > *Cloud** tab > **Set Up** next to **Cohere**.
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **Cohere** section under Model Providers.
4. Insert your **Cohere API Key**.


Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/remote-models/groq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Before proceeding, ensure you have the following:
3. There are three ways to configure your API Key in Jan app:
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **My Models** tab > **Add Icon (➕)** next to **Groq**.
- Navigate to the **Jan app** > **Thread** > **Model** tab > **Add Icon (➕)** next to **Groq**.
- Navigate to the **Jan app** > **Model Hub** > *Cloud** tab > **Set Up** next to **Groq**.
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **Groq** section under Model Providers.
4. Insert your **Groq API Key**.

### Step 2: Start Chatting with the Model
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/remote-models/martian.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Before proceeding, ensure you have the following:
3. There are three ways to configure your API Key in Jan app:
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **My Models** tab > **Add Icon (➕)** next to **Martian**.
- Navigate to the **Jan app** > **Thread** > **Model** tab > **Add Icon (➕)** next to **Martian**.
- Navigate to the **Jan app** > **Model Hub** > *Cloud** tab > **Set Up** next to **Martian**.
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **Martian** section under Model Providers.
4. Insert your **Martian API Key**.


Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/remote-models/mistralai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Before proceeding, ensure you have the following:
3. There are three ways to configure your API Key in Jan app:
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **My Models** tab > **Add Icon (➕)** next to **Mistral**.
- Navigate to the **Jan app** > **Thread** > **Model** tab > **Add Icon (➕)** next to **Mistral**.
- Navigate to the **Jan app** > **Model Hub** > *Cloud** tab > **Set Up** next to **Mistral**.
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **Mistral** section under Model Providers.
4. Insert your **Mistral API Key**.

<Callout type='info'>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/remote-models/nvidia-nim.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Before proceeding, ensure you have the following:
3. There are three ways to configure your API Key in Jan app:
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **My Models** tab > **Add Icon (➕)** next to **Nvidia**.
- Navigate to the **Jan app** > **Thread** > **Model** tab > **Add Icon (➕)** next to **Nvidia**.
- Navigate to the **Jan app** > **Model Hub** > *Cloud** tab > **Set Up** next to **Nvidia**.
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **NVIDIA NIM** section under Model Providers.
4. Insert your **Nvidia API Key**.


Expand Down
6 changes: 5 additions & 1 deletion src/pages/docs/remote-models/openai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ import { Callout, Steps } from 'nextra/components'

# OpenAI API

<Callout type='info'>
The OpenAI Extension can be used for any OpenAI-compatible API endpoints.
</Callout>

## How to Integrate OpenAI API with Jan
This guide provides step-by-step instructions for integrating the OpenAI API with Jan, allowing users to utilize OpenAI's capabilities within Jan's conversational interface.

Expand All @@ -34,7 +38,7 @@ This guide provides step-by-step instructions for integrating the OpenAI API wit
3. There are three ways to configure your API Key in Jan app:
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **My Models** tab > **Add Icon (➕)** next to **OpenAI**.
- Navigate to the **Jan app** > **Thread** > **Model** tab > **Add Icon (➕)** next to **OpenAI**.
- Navigate to the **Jan app** > **Model Hub** > *Cloud** tab > **Gear Icon (⚙️)** next to **OpenAI**.
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **OpenAI** section under Model Providers.
4. Insert your **OpenAI API Key**.

### Step 2: Start Chatting with the Model
Expand Down
3 changes: 2 additions & 1 deletion src/pages/docs/remote-models/openrouter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ To connect Jan with OpenRouter for accessing remote Large Language Models (LLMs)
3. There are three ways to configure your API Key in Jan app:
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **My Models** tab > **Add Icon (➕)** next to **OpenRouter**.
- Navigate to the **Jan app** > **Thread** > **Model** tab > **Add Icon (➕)** next to **OpenRouter**.
- Navigate to the **Jan app** > **Model Hub** > *Cloud** tab > **Set Up** next to **OpenRouter**.
- Navigate to the **Jan app** > **Gear Icon (⚙️)** > **OpenRouter** section under Model Providers.
4. Insert your **OpenRouter API Key**.
5. For the OpenRouter model, you need to specify the model you want to use. If you don't specify a model, the system will default to using the preset default model associated with OpenRouter.

### Step 2: Start Chatting with the Model

Expand Down
57 changes: 57 additions & 0 deletions src/pages/docs/remote-models/triton.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: Triton-TRT-LLM
description: Learn how to integrate Triton-TRT-LLM with Jan for enhanced functionality.
keywords:
[
Triton-TRT-LLM API,
Jan,
Jan AI,
ChatGPT alternative,
conversational AI,
large language model,
integration,
Triton-TRT-LLM integration,
API integration
]
---

import { Callout, Steps } from 'nextra/components'

# Triton-TRT-LLM

## How to Integrate Triton-TRT-LLM with Jan

This guide provides step-by-step instructions on integrating Triton-TRT-LLM with Jan, enabling users to leverage Triton-TRT-LLM's capabilities within Jan's conversational interface.

<Callout type='info'>
Triton-TRT-LLM extension is only supported on Jan version 0.5.1 or later.
</Callout>

Before proceeding, ensure you have the following:
- Access to the Jan application
- Triton-TRT-LLM credentials

## Integration Steps
<Steps>
### Step 1: Configure Triton-TRT-LLM API Key
1. Run [Triton-TRT-LLM](https://github.com/npuichigo/openai_trtllm) to obtain the API Keys.
2. Copy your **Triton-TRT-LLM Key**.
3. Navigate to the **Jan app** > **Gear Icon (⚙️)** > **Triton-TRT-LLM** section under Model Providers.
4. Insert your **Triton-TRT-LLM API Key**.


### Step 2: Start Chatting with the Model

1. Select the model you want to use.
2. Specify the model's parameters.
3. Start the conversation with the model.

</Steps>

## Troubleshooting

If you encounter any issues during the integration process or while using Triton-TRT-LLM with Jan, consider the following troubleshooting steps:

- Double-check your API credentials to ensure they are correct.
- Check for error messages or logs that may provide insight into the issue.
- Reach out to Triton-TRT-LLM support for assistance if needed.
1 change: 1 addition & 0 deletions src/pages/docs/shortcuts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,4 @@ Here are some of the keyboard shortcuts that you can use in Jan.
</Tabs.Tab>

</Tabs>

0 comments on commit a335520

Please sign in to comment.