Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Updated the sidebar and slug

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/docs/guides/get-started/settingup-gpu.mdx Normal file
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

2
docs/docs/guides/inference/overview-inference.mdx
View File

@ -1,6 +1,6 @@
---
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.
sidebar_position: 12
keywords:

22
docs/docs/guides/integrations/README.mdx Normal file
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 />

2
docs/docs/guides/integrations/overview-integration.mdx
View File

@ -1,6 +1,6 @@
---
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.
sidebar_position: 1
keywords:

2
docs/docs/guides/integrations/router.mdx
View File

@ -64,7 +64,7 @@ To connect Jan with OpenRouter for accessing remote Large Language Models (LLMs)
```
:::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

2
docs/docs/guides/local-providers/README.mdx
View File

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

1
docs/docs/guides/local-providers/llamacpp.mdx
View File

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

4
docs/docs/guides/local-providers/lmstudio.mdx
View File

@ -1,6 +1,6 @@
---
title: LM Studio
slug: /guides/providers/lmstudio
slug: /guides/engines/lmstudio
sidebar_position: 8
description: A step-by-step guide on how to integrate Jan with LM Studio.
keywords:
@ -82,7 +82,7 @@ Replace `(port)` with your chosen port number. The default is 1234.
}
```
:::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).
:::

4
docs/docs/guides/local-providers/ollama.mdx
View File

@ -1,6 +1,6 @@
---
title: Ollama
slug: /guides/providers/ollama
slug: /guides/engines/ollama
sidebar_position: 4
description: A step-by-step guide on how to integrate Jan with Ollama.
keywords:
@ -81,7 +81,7 @@ ollama run <model-name>
}
```
:::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

1
docs/docs/guides/local-providers/tensorrt.mdx
View File

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

2
docs/docs/guides/remote-providers/README.mdx
View File

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

2
docs/docs/guides/remote-providers/claude.mdx
View File

@ -1,7 +1,7 @@
---
title: Claude
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.
keywords:
[

2
docs/docs/guides/remote-providers/groq.mdx
View File

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

4
docs/docs/guides/remote-providers/mistral.mdx
View File

@ -1,7 +1,7 @@
---
title: Mistral AI
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.
keywords:
[
@ -77,7 +77,7 @@ This tutorial demonstrates integrating Mistral AI with Jan using the API.
```
:::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.
:::

4
docs/docs/guides/remote-providers/openai.mdx
View File

@ -1,7 +1,7 @@
---
title: Azure OpenAI
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.
keywords:
[
@ -72,7 +72,7 @@ The [Azure OpenAI Service](https://learn.microsoft.com/en-us/azure/ai-services/o
```
:::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

2
docs/docs/guides/remote-providers/remote-server-integration.mdx
View File

@ -1,7 +1,7 @@
---
title: Remote Server Integration
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.
keywords:
[

43
docs/sidebars.js
View File

@ -172,7 +172,19 @@ const sidebars = {
items: [
"guides/get-started/overview",
"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",
label: "Installation",
@ -207,7 +219,7 @@ const sidebars = {
},
{
type: "category",
label: "Inference Providers",
label: "Inference Engines",
collapsible: false,
className: "head_Menu",
items: [
@ -260,14 +272,25 @@ const sidebars = {
collapsible: false,
className: "head_Menu",
items: [
"guides/integrations/overview-integration",
"guides/integrations/crewai",
"guides/integrations/discord",
"guides/integrations/interpreter",
"guides/integrations/raycast",
"guides/integrations/router",
"guides/integrations/unsloth",
"guides/integrations/vscode"
// "guides/integrations/overview-integration",
{
type: "category",
label: "Integrations",
className: "head_SubMenu",
link: {
type: 'doc',
id: "guides/integrations/README",
},
items: [
"guides/integrations/crewai",
"guides/integrations/discord",
"guides/integrations/interpreter",
"guides/integrations/raycast",
"guides/integrations/router",
"guides/integrations/unsloth",
"guides/integrations/vscode"
]
},
]
},
{

6
docs/src/components/HomepageTerinaryFeatures/index.js
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>
<ul className="mt-5">
<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
</a>
</li>
<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
</a>
</li>
<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
</a>
</li>

2
docs/src/theme/DocCard/index.js
View File

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