diff --git a/docs/docs/guides/get-started/settingup-gpu.mdx b/docs/docs/guides/get-started/settingup-gpu.mdx new file mode 100644 index 000000000..90a3743c4 --- /dev/null +++ b/docs/docs/guides/get-started/settingup-gpu.mdx @@ -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 \ No newline at end of file diff --git a/docs/docs/guides/inference/overview-inference.mdx b/docs/docs/guides/inference/overview-inference.mdx index 0c4e35723..cd51bb44e 100644 --- a/docs/docs/guides/inference/overview-inference.mdx +++ b/docs/docs/guides/inference/overview-inference.mdx @@ -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: diff --git a/docs/docs/guides/integrations/README.mdx b/docs/docs/guides/integrations/README.mdx new file mode 100644 index 000000000..6204df305 --- /dev/null +++ b/docs/docs/guides/integrations/README.mdx @@ -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"; + + diff --git a/docs/docs/guides/integrations/overview-integration.mdx b/docs/docs/guides/integrations/overview-integration.mdx index 4e751c7d1..e7ce1e3b3 100644 --- a/docs/docs/guides/integrations/overview-integration.mdx +++ b/docs/docs/guides/integrations/overview-integration.mdx @@ -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: diff --git a/docs/docs/guides/integrations/router.mdx b/docs/docs/guides/integrations/router.mdx index b5fe7bc77..e9f6580ee 100644 --- a/docs/docs/guides/integrations/router.mdx +++ b/docs/docs/guides/integrations/router.mdx @@ -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 diff --git a/docs/docs/guides/local-providers/README.mdx b/docs/docs/guides/local-providers/README.mdx index 2f6404a6b..5c83648e3 100644 --- a/docs/docs/guides/local-providers/README.mdx +++ b/docs/docs/guides/local-providers/README.mdx @@ -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: diff --git a/docs/docs/guides/local-providers/llamacpp.mdx b/docs/docs/guides/local-providers/llamacpp.mdx index 2bda9b153..3661a3ca1 100644 --- a/docs/docs/guides/local-providers/llamacpp.mdx +++ b/docs/docs/guides/local-providers/llamacpp.mdx @@ -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: diff --git a/docs/docs/guides/local-providers/lmstudio.mdx b/docs/docs/guides/local-providers/lmstudio.mdx index 343f15339..c7d7a6236 100644 --- a/docs/docs/guides/local-providers/lmstudio.mdx +++ b/docs/docs/guides/local-providers/lmstudio.mdx @@ -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). ::: diff --git a/docs/docs/guides/local-providers/ollama.mdx b/docs/docs/guides/local-providers/ollama.mdx index d7aa65357..49c8d4001 100644 --- a/docs/docs/guides/local-providers/ollama.mdx +++ b/docs/docs/guides/local-providers/ollama.mdx @@ -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 } ``` :::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 diff --git a/docs/docs/guides/local-providers/tensorrt.mdx b/docs/docs/guides/local-providers/tensorrt.mdx index d997e919c..5cd529a49 100644 --- a/docs/docs/guides/local-providers/tensorrt.mdx +++ b/docs/docs/guides/local-providers/tensorrt.mdx @@ -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: diff --git a/docs/docs/guides/remote-providers/README.mdx b/docs/docs/guides/remote-providers/README.mdx index a76a4fa68..46a126882 100644 --- a/docs/docs/guides/remote-providers/README.mdx +++ b/docs/docs/guides/remote-providers/README.mdx @@ -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: diff --git a/docs/docs/guides/remote-providers/claude.mdx b/docs/docs/guides/remote-providers/claude.mdx index f8534c2f1..778761cd4 100644 --- a/docs/docs/guides/remote-providers/claude.mdx +++ b/docs/docs/guides/remote-providers/claude.mdx @@ -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: [ diff --git a/docs/docs/guides/remote-providers/groq.mdx b/docs/docs/guides/remote-providers/groq.mdx index 5347e94a8..c9837bcfc 100644 --- a/docs/docs/guides/remote-providers/groq.mdx +++ b/docs/docs/guides/remote-providers/groq.mdx @@ -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: [ diff --git a/docs/docs/guides/remote-providers/mistral.mdx b/docs/docs/guides/remote-providers/mistral.mdx index cc3304a9c..38f2dda25 100644 --- a/docs/docs/guides/remote-providers/mistral.mdx +++ b/docs/docs/guides/remote-providers/mistral.mdx @@ -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. ::: diff --git a/docs/docs/guides/remote-providers/openai.mdx b/docs/docs/guides/remote-providers/openai.mdx index 85009c938..7b1bc4cfa 100644 --- a/docs/docs/guides/remote-providers/openai.mdx +++ b/docs/docs/guides/remote-providers/openai.mdx @@ -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 diff --git a/docs/docs/guides/remote-providers/remote-server-integration.mdx b/docs/docs/guides/remote-providers/remote-server-integration.mdx index fb4f0c6ac..eb1e0bab7 100644 --- a/docs/docs/guides/remote-providers/remote-server-integration.mdx +++ b/docs/docs/guides/remote-providers/remote-server-integration.mdx @@ -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: [ diff --git a/docs/sidebars.js b/docs/sidebars.js index 163630efe..228a49d06 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -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" + ] + }, ] }, { diff --git a/docs/src/components/HomepageTerinaryFeatures/index.js b/docs/src/components/HomepageTerinaryFeatures/index.js index 9ecd82ed1..bd4588e96 100644 --- a/docs/src/components/HomepageTerinaryFeatures/index.js +++ b/docs/src/components/HomepageTerinaryFeatures/index.js @@ -64,17 +64,17 @@ export default function HomepageTerinaryFeatures() {

Learn how to build and integrate Jan with local and remote inference providers.