docs: Updated the sidebar and slug

This commit is contained in:
Arista Indrajaya 2024-03-19 16:17:09 +07:00
parent 883fbce0bf
commit 0ada351a3f
19 changed files with 96 additions and 30 deletions

View File

@ -0,0 +1,19 @@
---
title: Setting Up GPU
slug: /guides/hardware/gpu
description: Jan Docs | Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
sidebar_position: 1
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
]
---
Coming Soon

View File

@ -1,6 +1,6 @@
--- ---
title: Overview title: Overview
slug: /guides/providers slug: /guides/engines
description: Jan Docs | Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. description: Jan Docs | Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
sidebar_position: 12 sidebar_position: 12
keywords: keywords:

View File

@ -0,0 +1,22 @@
---
title: Integrations
slug: /integrations/
sidebar_position: 1
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
build extension,
]
---
import DocCardList from "@theme/DocCardList";
<DocCardList />

View File

@ -1,6 +1,6 @@
--- ---
title: Overview title: Overview
slug: /integrations slug: /integrationss
description: Jan Docs | Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. description: Jan Docs | Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
sidebar_position: 1 sidebar_position: 1
keywords: keywords:

View File

@ -64,7 +64,7 @@ To connect Jan with OpenRouter for accessing remote Large Language Models (LLMs)
``` ```
:::note :::note
For more details regarding the `model.json` settings and parameters fields, please see [here](/guides/providers/remote-server/#modeljson). For more details regarding the `model.json` settings and parameters fields, please see [here](/guides/engines/remote-server/#modeljson).
::: :::
### Step 3 : Start the Model ### Step 3 : Start the Model

View File

@ -1,6 +1,6 @@
--- ---
title: Local Providers title: Local Providers
slug: /guides/providers/local slug: /guides/engines/local
sidebar_position: 13 sidebar_position: 13
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords: keywords:

View File

@ -1,5 +1,6 @@
--- ---
title: LlamaCPP Extension title: LlamaCPP Extension
slug: /guides/engines/llamacpp
sidebar_position: 1 sidebar_position: 1
description: A step-by-step guide on how to customize the LlamaCPP extension. description: A step-by-step guide on how to customize the LlamaCPP extension.
keywords: keywords:

View File

@ -1,6 +1,6 @@
--- ---
title: LM Studio title: LM Studio
slug: /guides/providers/lmstudio slug: /guides/engines/lmstudio
sidebar_position: 8 sidebar_position: 8
description: A step-by-step guide on how to integrate Jan with LM Studio. description: A step-by-step guide on how to integrate Jan with LM Studio.
keywords: keywords:
@ -82,7 +82,7 @@ Replace `(port)` with your chosen port number. The default is 1234.
} }
``` ```
:::note :::note
For more details regarding the `model.json` settings and parameters fields, please see [here](/guides/providers/remote-server/#modeljson). For more details regarding the `model.json` settings and parameters fields, please see [here](/guides/engines/remote-server/#modeljson).
::: :::

View File

@ -1,6 +1,6 @@
--- ---
title: Ollama title: Ollama
slug: /guides/providers/ollama slug: /guides/engines/ollama
sidebar_position: 4 sidebar_position: 4
description: A step-by-step guide on how to integrate Jan with Ollama. description: A step-by-step guide on how to integrate Jan with Ollama.
keywords: keywords:
@ -81,7 +81,7 @@ ollama run <model-name>
} }
``` ```
:::note :::note
For more details regarding the `model.json` settings and parameters fields, please see [here](/guides/providers/remote-server/#modeljson). For more details regarding the `model.json` settings and parameters fields, please see [here](/guides/engines/remote-server/#modeljson).
::: :::
### Step 3: Start the Model ### Step 3: Start the Model

View File

@ -1,5 +1,6 @@
--- ---
title: TensorRT-LLM Extension title: TensorRT-LLM Extension
slug: /guides/engines/tensorrt-llm
sidebar_position: 2 sidebar_position: 2
description: A step-by-step guide on how to customize the TensorRT-LLM extension. description: A step-by-step guide on how to customize the TensorRT-LLM extension.
keywords: keywords:

View File

@ -1,6 +1,6 @@
--- ---
title: Remote Providers title: Remote Providers
slug: /guides/providers/remote slug: /guides/engines/remote
sidebar_position: 14 sidebar_position: 14
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords: keywords:

View File

@ -1,7 +1,7 @@
--- ---
title: Claude title: Claude
sidebar_position: 6 sidebar_position: 6
slug: /guides/providers/claude slug: /guides/engines/claude
description: A step-by-step guide on how to integrate Jan with LM Studio. description: A step-by-step guide on how to integrate Jan with LM Studio.
keywords: keywords:
[ [

View File

@ -1,7 +1,7 @@
--- ---
title: Groq title: Groq
sidebar_position: 5 sidebar_position: 5
slug: /guides/providers/groq slug: /guides/engines/groq
description: Learn how to integrate Groq API with Jan for enhanced functionality. description: Learn how to integrate Groq API with Jan for enhanced functionality.
keywords: keywords:
[ [

View File

@ -1,7 +1,7 @@
--- ---
title: Mistral AI title: Mistral AI
sidebar_position: 4 sidebar_position: 4
slug: /guides/providers/mistral slug: /guides/engines/mistral
description: A step-by-step guide on how to integrate Jan with Mistral AI. description: A step-by-step guide on how to integrate Jan with Mistral AI.
keywords: keywords:
[ [
@ -77,7 +77,7 @@ This tutorial demonstrates integrating Mistral AI with Jan using the API.
``` ```
:::note :::note
- For more details regarding the `model.json` settings and parameters fields, please see [here](/guides/providers/remote-server/#modeljson). - For more details regarding the `model.json` settings and parameters fields, please see [here](/guides/engines/remote-server/#modeljson).
- Mistral AI offers various endpoints. Refer to their [endpoint documentation](https://docs.mistral.ai/platform/endpoints/) to select the one that fits your requirements. Here, we use the `mistral-tiny` model as an example. - Mistral AI offers various endpoints. Refer to their [endpoint documentation](https://docs.mistral.ai/platform/endpoints/) to select the one that fits your requirements. Here, we use the `mistral-tiny` model as an example.
::: :::

View File

@ -1,7 +1,7 @@
--- ---
title: Azure OpenAI title: Azure OpenAI
sidebar_position: 2 sidebar_position: 2
slug: /guides/providers/openai slug: /guides/engines/openai
description: A step-by-step guide on how to integrate Jan with Azure OpenAI. description: A step-by-step guide on how to integrate Jan with Azure OpenAI.
keywords: keywords:
[ [
@ -72,7 +72,7 @@ The [Azure OpenAI Service](https://learn.microsoft.com/en-us/azure/ai-services/o
``` ```
:::note :::note
For more details regarding the `model.json` settings and parameters fields, please see [here](/guides/providers/remote-server/#modeljson). For more details regarding the `model.json` settings and parameters fields, please see [here](/guides/engines/remote-server/#modeljson).
::: :::
### Step 3: Start the Model ### Step 3: Start the Model

View File

@ -1,7 +1,7 @@
--- ---
title: Remote Server Integration title: Remote Server Integration
sidebar_position: 1 sidebar_position: 1
slug: /guides/providers/remote-server slug: /guides/engines/remote-server
description: A step-by-step guide on how to set up Jan to connect with any remote or local API server. description: A step-by-step guide on how to set up Jan to connect with any remote or local API server.
keywords: keywords:
[ [

View File

@ -172,7 +172,19 @@ const sidebars = {
items: [ items: [
"guides/get-started/overview", "guides/get-started/overview",
"guides/get-started/quickstart", "guides/get-started/quickstart",
"guides/get-started/hardware-setup",
{
type: "category",
label: "Hardware Setup",
className: "head_SubMenu",
link: {
type: 'doc',
id: "guides/get-started/hardware-setup",
},
items: [
"guides/get-started/settingup-gpu",
]
},
{ {
type: "category", type: "category",
label: "Installation", label: "Installation",
@ -207,7 +219,7 @@ const sidebars = {
}, },
{ {
type: "category", type: "category",
label: "Inference Providers", label: "Inference Engines",
collapsible: false, collapsible: false,
className: "head_Menu", className: "head_Menu",
items: [ items: [
@ -260,7 +272,16 @@ const sidebars = {
collapsible: false, collapsible: false,
className: "head_Menu", className: "head_Menu",
items: [ items: [
"guides/integrations/overview-integration", // "guides/integrations/overview-integration",
{
type: "category",
label: "Integrations",
className: "head_SubMenu",
link: {
type: 'doc',
id: "guides/integrations/README",
},
items: [
"guides/integrations/crewai", "guides/integrations/crewai",
"guides/integrations/discord", "guides/integrations/discord",
"guides/integrations/interpreter", "guides/integrations/interpreter",
@ -270,6 +291,8 @@ const sidebars = {
"guides/integrations/vscode" "guides/integrations/vscode"
] ]
}, },
]
},
{ {
type: "category", type: "category",
label: "Troubleshooting", label: "Troubleshooting",

View File

@ -64,17 +64,17 @@ export default function HomepageTerinaryFeatures() {
<p className="text-gray-700 dark:text-gray-200">Learn how to build and integrate Jan with local and remote inference providers.</p> <p className="text-gray-700 dark:text-gray-200">Learn how to build and integrate Jan with local and remote inference providers.</p>
<ul className="mt-5"> <ul className="mt-5">
<li className="font-semibold list-disc mb-4"> <li className="font-semibold list-disc mb-4">
<a href={"/guides/providers/"} className="dark:text-blue-400"> <a href={"/guides/engines/"} className="dark:text-blue-400">
Overview Overview
</a> </a>
</li> </li>
<li className="font-semibold list-disc mb-4"> <li className="font-semibold list-disc mb-4">
<a href={"/guides/providers/local/"} className="dark:text-blue-400"> <a href={"/guides/engines/local/"} className="dark:text-blue-400">
Local Providers Local Providers
</a> </a>
</li> </li>
<li className="font-semibold list-disc mb-4"> <li className="font-semibold list-disc mb-4">
<a href={"/guides/providers/remote/"} className="dark:text-blue-400"> <a href={"/guides/engines/remote/"} className="dark:text-blue-400">
Remote Providers Remote Providers
</a> </a>
</li> </li>

View File

@ -137,7 +137,7 @@ function CardLink({item}) {
<img src={setup} alt="Logo" width={'20px'} height={'20px'} style={{marginRight: '5px'}} /> <img src={setup} alt="Logo" width={'20px'} height={'20px'} style={{marginRight: '5px'}} />
) : (item.label === "Import Extensions") ? ( ) : (item.label === "Import Extensions") ? (
<img src={importex} alt="Logo" width={'20px'} height={'20px'} style={{marginRight: '5px'}} /> <img src={importex} alt="Logo" width={'20px'} height={'20px'} style={{marginRight: '5px'}} />
) : (item.label === "Continue") ? ( ) : (item.label === "Continue Integration") ? (
<img src={continueint} alt="Logo" width={'20px'} height={'20px'} style={{marginRight: '5px'}} /> <img src={continueint} alt="Logo" width={'20px'} height={'20px'} style={{marginRight: '5px'}} />
) : (item.label === "OpenRouter") ? ( ) : (item.label === "OpenRouter") ? (
<img src={openrouter} alt="Logo" width={'20px'} height={'20px'} style={{marginRight: '5px'}} /> <img src={openrouter} alt="Logo" width={'20px'} height={'20px'} style={{marginRight: '5px'}} />