From 4a267ff35b0c2aaa1a1986e980c2303e4146dcde Mon Sep 17 00:00:00 2001 From: hiro Date: Tue, 19 Mar 2024 00:15:30 +0700 Subject: [PATCH 1/4] feat: Add SEO header tag with OpenAI GPT-4 --- ...0-2024-bitdefender-false-positive-flag.mdx | 15 +++++ .../developer/01-overview/01-architecture.md | 14 ++++ .../developer/01-overview/02-file-based.md | 14 ++++ .../01-overview/03-user-interface.md | 14 ++++ .../04-install-and-prerequisites.md | 14 ++++ docs/docs/developer/01-overview/README.md | 14 ++++ .../01-your-first-extension.md | 20 +++++- .../guides/error-codes/permission-denied.mdx | 16 ++++- docs/docs/guides/extensions/setup-ext.mdx | 13 ++++ docs/docs/hardware/community.md | 33 ++++++++-- docs/docs/hardware/concepts/gpu-and-vram.md | 14 ++++ .../hardware/recommendations/by-budget.md | 14 ++++ .../hardware/recommendations/by-hardware.md | 14 ++++ .../docs/hardware/recommendations/by-model.md | 14 ++++ .../hardware/recommendations/by-usecase.md | 14 ++++ docs/docs/privacy/privacy.md | 18 ++++++ docs/docs/support/support.md | 18 ++++++ docs/docs/template/QA_script.md | 64 +++++++++++++++++-- 18 files changed, 324 insertions(+), 13 deletions(-) diff --git a/docs/blog/01-january-10-2024-bitdefender-false-positive-flag.mdx b/docs/blog/01-january-10-2024-bitdefender-false-positive-flag.mdx index ef418ff97..6c208764d 100644 --- a/docs/blog/01-january-10-2024-bitdefender-false-positive-flag.mdx +++ b/docs/blog/01-january-10-2024-bitdefender-false-positive-flag.mdx @@ -5,6 +5,21 @@ slug: /postmortems/january-10-2024-bitdefender-false-positive-flag tags: [Postmortem] --- + + Jan 10, 2024 Incident Postmortem - Bitdefender False Positive Flag on Jan AI Resolved + + + + + + + + + + + + + Following the recent incident related to Jan version 0.4.4 triggering Bitdefender on Windows with Gen:Variant.Tedy.258323 on January 10, 2024, we wanted to provide a comprehensive postmortem and outline the necessary follow-up actions. ## Incident Overview diff --git a/docs/docs/developer/01-overview/01-architecture.md b/docs/docs/developer/01-overview/01-architecture.md index 432b12537..218964bed 100644 --- a/docs/docs/developer/01-overview/01-architecture.md +++ b/docs/docs/developer/01-overview/01-architecture.md @@ -15,6 +15,20 @@ keywords: ] --- + + Jan AI Architecture - Modular and Extensible Framework + + + + + + + + + + + + :::warning This page is still under construction, and should be read as a scratchpad diff --git a/docs/docs/developer/01-overview/02-file-based.md b/docs/docs/developer/01-overview/02-file-based.md index 653eba3f5..2cd8a554c 100644 --- a/docs/docs/developer/01-overview/02-file-based.md +++ b/docs/docs/developer/01-overview/02-file-based.md @@ -15,6 +15,20 @@ keywords: ] --- + + Jan AI File-based Data Persistence Approach + + + + + + + + + + + + :::warning This page is still under construction, and should be read as a scratchpad diff --git a/docs/docs/developer/01-overview/03-user-interface.md b/docs/docs/developer/01-overview/03-user-interface.md index eb6eac89e..fa5a3de79 100644 --- a/docs/docs/developer/01-overview/03-user-interface.md +++ b/docs/docs/developer/01-overview/03-user-interface.md @@ -15,6 +15,20 @@ keywords: ] --- + + Jan AI User Interface - Customizable UI Kit + + + + + + + + + + + + :::warning This page is still under construction, and should be read as a scratchpad diff --git a/docs/docs/developer/01-overview/04-install-and-prerequisites.md b/docs/docs/developer/01-overview/04-install-and-prerequisites.md index 9752f7b72..a3e6ccfc1 100644 --- a/docs/docs/developer/01-overview/04-install-and-prerequisites.md +++ b/docs/docs/developer/01-overview/04-install-and-prerequisites.md @@ -18,6 +18,20 @@ keywords: ] --- + + Jan AI Installation and Setup Guide - Developer Prerequisites + + + + + + + + + + + + ## Requirements ### Hardware Requirements diff --git a/docs/docs/developer/01-overview/README.md b/docs/docs/developer/01-overview/README.md index 7bc3524de..4f094685a 100644 --- a/docs/docs/developer/01-overview/README.md +++ b/docs/docs/developer/01-overview/README.md @@ -15,6 +15,20 @@ keywords: ] --- + + Jan AI Developer Documentation - Building Extensions and SDK Overview + + + + + + + + + + + + The following docs are aimed at developers who want to build extensions on top of the Jan Framework. :::tip diff --git a/docs/docs/developer/04-build-extension/01-your-first-extension.md b/docs/docs/developer/04-build-extension/01-your-first-extension.md index f89f34053..3fa9f5da5 100644 --- a/docs/docs/developer/04-build-extension/01-your-first-extension.md +++ b/docs/docs/developer/04-build-extension/01-your-first-extension.md @@ -17,6 +17,20 @@ keywords: ] --- + + Building Your First Jan AI Extension - Quick Start Guide + + + + + + + + + + + + :::caution This is currently under development. ::: @@ -76,13 +90,13 @@ There are a few things to keep in mind when writing your extension code: In `index.ts`, you will see that the extension function will return a `Promise`. ```typescript - import { core } from "@janhq/core"; + import { core } from '@janhq/core' function onStart(): Promise { - return core.invokePluginFunc(MODULE_PATH, "run", 0); + return core.invokePluginFunc(MODULE_PATH, 'run', 0) } ``` For more information about the Jan Extension Core module, see the [documentation](https://github.com/janhq/jan/blob/main/core/README.md). -Now, go ahead and start customizing your extension! Happy coding! \ No newline at end of file +Now, go ahead and start customizing your extension! Happy coding! diff --git a/docs/docs/guides/error-codes/permission-denied.mdx b/docs/docs/guides/error-codes/permission-denied.mdx index 1d41d3b03..a1c3577f9 100644 --- a/docs/docs/guides/error-codes/permission-denied.mdx +++ b/docs/docs/guides/error-codes/permission-denied.mdx @@ -17,7 +17,21 @@ keywords: ] --- -When running Jan, you might encounter the following error message: + + Resolving "Permission Denied" Error in Jan AI + + + + + + + + + + + + +When you run Jan, you may encounter the following error: ``` Uncaught (in promise) Error: Error invoking layout-480796bff433a3a3.js:538 remote method 'installExtension': diff --git a/docs/docs/guides/extensions/setup-ext.mdx b/docs/docs/guides/extensions/setup-ext.mdx index c080283e9..b8e1f757d 100644 --- a/docs/docs/guides/extensions/setup-ext.mdx +++ b/docs/docs/guides/extensions/setup-ext.mdx @@ -16,6 +16,19 @@ keywords: ] --- + + Configuring Extension Settings in Jan AI - User Guide + + + + + + + + + + + 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. diff --git a/docs/docs/hardware/community.md b/docs/docs/hardware/community.md index e1825b24b..5ba920d89 100644 --- a/docs/docs/hardware/community.md +++ b/docs/docs/hardware/community.md @@ -1,12 +1,36 @@ --- title: Hardware Examples 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 ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- + + Hardware Examples + + + + + + + + + + + + ## Add your own example -Add your own examples to this page by creating a new file in the `docs/docs/hardware/examples` directory. +Add your own examples to this page by creating a new file in the `docs/docs/hardware/examples` directory. ```shell docs @@ -18,9 +42,10 @@ docs // highlight-next-line └── .md ``` + ### File and Title Convention -We use a specific naming convention for the file name. +We use a specific naming convention for the file name. ```shell # Filename @@ -52,4 +77,4 @@ You are allowed to include affiliate links in your example. ## Longer-Term -We will likely build a simple web app to make it easier to add your own examples, sort and retrieve. \ No newline at end of file +We will likely build a simple web app to make it easier to add your own examples, sort and retrieve. diff --git a/docs/docs/hardware/concepts/gpu-and-vram.md b/docs/docs/hardware/concepts/gpu-and-vram.md index 57387e8d2..0a9316a90 100644 --- a/docs/docs/hardware/concepts/gpu-and-vram.md +++ b/docs/docs/hardware/concepts/gpu-and-vram.md @@ -2,6 +2,20 @@ title: GPUs and VRAM --- + + Understanding GPUs and VRAM for AI and Gaming + + + + + + + + + + + + ## What Is a GPU? A Graphics Card, or GPU (Graphics Processing Unit), is a fundamental component in modern computing. Think of it as the powerhouse behind rendering the stunning visuals you see on your screen. Similar to the motherboard in your computer, the graphics card is a printed circuit board. However, it's not just a passive piece of hardware; it's a sophisticated device equipped with essential components like fans, onboard RAM, a dedicated memory controller, BIOS, and various other features. If you want to learn more about GPUs then read here to [Understand the architecture of a GPU.](https://medium.com/codex/understanding-the-architecture-of-a-gpu-d5d2d2e8978b) diff --git a/docs/docs/hardware/recommendations/by-budget.md b/docs/docs/hardware/recommendations/by-budget.md index 9e640fbc9..e556c77d3 100644 --- a/docs/docs/hardware/recommendations/by-budget.md +++ b/docs/docs/hardware/recommendations/by-budget.md @@ -2,6 +2,20 @@ title: Recommended AI Hardware by Budget --- + + Recommended AI Hardware Builds by Budget + + + + + + + + + + + + > :warning: **Warning:** Do your own research before any purchase. Jan is not liable for compatibility, performance or other issues. Products can become outdated quickly. ## Entry-level PC Build at $1000 diff --git a/docs/docs/hardware/recommendations/by-hardware.md b/docs/docs/hardware/recommendations/by-hardware.md index ee80a290c..dcd744d8b 100644 --- a/docs/docs/hardware/recommendations/by-hardware.md +++ b/docs/docs/hardware/recommendations/by-hardware.md @@ -2,6 +2,20 @@ title: Selecting AI Hardware --- + + Selecting AI Hardware + + + + + + + + + + + + When selecting a GPU for LLMs, remember that it's not just about the GPU itself. Consider the synergy with other components in your PC: - **CPU**: To ensure efficient processing, pair your GPU with a powerful CPU. LLMs benefit from fast processors, so having a capable CPU is essential. diff --git a/docs/docs/hardware/recommendations/by-model.md b/docs/docs/hardware/recommendations/by-model.md index 99d1ca8a2..e9fe1c3e8 100644 --- a/docs/docs/hardware/recommendations/by-model.md +++ b/docs/docs/hardware/recommendations/by-model.md @@ -2,6 +2,20 @@ title: Recommended AI Hardware by Model --- + + Recommended AI Hardware by Model + + + + + + + + + + + + ## Codellama 34b ### System Requirements: diff --git a/docs/docs/hardware/recommendations/by-usecase.md b/docs/docs/hardware/recommendations/by-usecase.md index 2ae0cb906..aa7a1bf75 100644 --- a/docs/docs/hardware/recommendations/by-usecase.md +++ b/docs/docs/hardware/recommendations/by-usecase.md @@ -2,6 +2,20 @@ title: Recommended AI Hardware by Use Case --- + + Recommended AI Hardware by Model + + + + + + + + + + + + ## Which AI Hardware to Choose Based on Your Use Case Artificial intelligence (AI) is rapidly changing the world, and AI hardware is becoming increasingly important for businesses and individuals alike. Choosing the right hardware for your AI needs is crucial to get the best performance and results. Here are some tips for selecting AI hardware based on your specific use case and requirements. diff --git a/docs/docs/privacy/privacy.md b/docs/docs/privacy/privacy.md index 56e81f3a1..e1f5d0f10 100644 --- a/docs/docs/privacy/privacy.md +++ b/docs/docs/privacy/privacy.md @@ -1,3 +1,21 @@ +--- +title: Privacy - Jan +--- + + + Privacy Policy - Jan + + + + + + + + + + + + # Privacy Policy Jan is committed to protecting your privacy and ensuring that your personal information is handled in a safe and responsible way. This policy outlines how we collect, store, and use your personal information when you use our mobile application. diff --git a/docs/docs/support/support.md b/docs/docs/support/support.md index 5a1ec2097..856041f86 100644 --- a/docs/docs/support/support.md +++ b/docs/docs/support/support.md @@ -1,3 +1,21 @@ +--- +title: Support - Jan +--- + + + Support - Jan + + + + + + + + + + + + # Support - Bugs & requests: file a GitHub ticket [here](https://github.com/janhq/jan/issues) diff --git a/docs/docs/template/QA_script.md b/docs/docs/template/QA_script.md index 9c7eeaf18..d0ba4b90f 100644 --- a/docs/docs/template/QA_script.md +++ b/docs/docs/template/QA_script.md @@ -1,5 +1,25 @@ +--- +title: Jan version release template +--- + + + Release Version QA Script template + + + + + + + + + + + + # Regression test +# [Release Version] QA Script + **Release Version:** v0.4.7 **Operating System:** MacOS @@ -26,7 +46,6 @@ - [ ] :key::warning: Check that the uninstallation process removes the app successfully from the system. - [ ] Clean the Jan root directory and open the app to check if it creates all the necessary folders, especially models and extensions. - ## B. Overview ### 1. Shortcut key, memory usage / CPU usage @@ -71,10 +90,18 @@ - [ ] :key: Ensure that users switch between threads with different models, the app can handle it. ### 3. Model dropdown + - [ ] :key: Model list should highlight recommended based on user RAM - [ ] Model size should display (for both installed and imported models) ### 4. Users can click on a history thread + +# <<<<<<< HEAD + +- [ ] Test the ability to click on any thread in the history panel. +- [ ] :key: Verify that clicking a thread brings up the past conversation in the main chat window. +- [ ] :key: Ensure that the selected thread is highlighted or otherwise indicated in the history panel. + > > > > > > > f2847d56c (feat: Add SEO header tag with OpenAI GPT-4) - [ ] Confirm that the chat window displays the entire conversation from the selected history thread without any missing messages. - [ ] :key: Check the performance and accuracy of the history feature when dealing with a large number of threads. - [ ] Validate that historical threads reflect the exact state of the chat at that time, including settings. @@ -82,12 +109,16 @@ - [ ] Confirm that changing the title of the thread updates correctly. ### 5. Users can config instructions for the assistant. + +# <<<<<<< HEAD + +- [ ] Ensure there is a clear interface to input or change instructions for the assistant. + > > > > > > > f2847d56c (feat: Add SEO header tag with OpenAI GPT-4) - [ ] Test if the instructions set by the user are being followed by the assistant in subsequent conversations. - [ ] :key: Validate that changes to instructions are updated in real time and do not require a restart of the application or session. - [ ] :key: Check for the ability to reset instructions to default or clear them completely. - [ ] :key: RAG - Users can import documents and the system should process queries about the uploaded file, providing accurate and appropriate responses in the conversation thread. - ## D. Hub ### 1. Users can discover recommended models (Jan ships with a few preconfigured model.json files) @@ -117,13 +148,14 @@ ### 5. Users can use the model as they want -- [ ] :key: Check `start` / `stop` / `delete` button response exactly what it does. +- [ ] :key: Check `start` / `stop` / `delete` button response exactly what it does. - [ ] Check if starting another model stops the other model entirely. - [x] :rocket: Check the `Explore models` navigate correctly to the model panel. - [ ] :key: Check when deleting a model it will delete all the files on the user's computer. - [ ] :warning:The recommended tags should present right for the user's hardware. ### 6. Users can Integrate With a Remote Server + - [ ] :key: Import openAI GPT model https://jan.ai/guides/using-models/integrate-with-remote-server/ and the model displayed in Hub / Thread dropdown - [ ] Users can use the remote model properly @@ -175,6 +207,27 @@ - [ ] :key: Test the `Experimental Mode` toggle to confirm it enables or disables experimental features as intended. - [ ] :key: Check the functionality of `Open App Directory` to ensure it opens the correct folder in the system file explorer. + <<<<<<< HEAD + ======= +- [ ] Validate that changes in advanced settings are applied immediately or provide appropriate instructions if a restart is needed. +- [ ] Test the application's stability when experimental features are enabled. + +### 4. Users can add custom plugins via manual installation [TBU] + +- [ ] Verify that the `Manual Installation` option is clearly visible and accessible in the `Extensions` section. +- [ ] Test the functionality of the `Select` button within the `Manual Installation` area. +- [ ] :warning: Check that the file picker dialog allows for the correct plugin file types (e.g., .tgz). +- [ ] :key: Validate that the selected plugin file installs correctly and the plugin becomes functional. +- [ ] Ensure that there is a progress indicator or confirmation message once the installation is complete. +- [ ] Confirm that if the installation is interrupted or fails, the user is given a clear error message. +- [ ] :key: Test that the application prevents the installation of incompatible or corrupt plugin files. +- [ ] :key: Check that the user can uninstall or disable custom plugins as easily as pre-installed ones. +- [ ] Verify that the application's performance remains stable after the installation of custom plugins. + +### 5. Advanced Settings + +- [ ] Attemp to test downloading model from hub using **HTTP Proxy** [guideline](https://github.com/janhq/jan/pull/1562) + > > > > > > > f2847d56c (feat: Add SEO header tag with OpenAI GPT-4) - [ ] Users can move **Jan data folder** - [ ] Validate that changes in advanced settings are applied immediately or provide appropriate instructions if a restart is needed. - [ ] Attemp to test downloading model from hub using **HTTP Proxy** [guideline](https://github.com/janhq/jan/pull/1562) @@ -184,9 +237,10 @@ ## G. Local API server ### 1. Local Server Usage with Server Options + - [ ] :key: Explore API Reference: Swagger API for sending/receiving requests - - [ ] Use default server option - - [ ] Configure and use custom server options + - [ ] Use default server option + - [ ] Configure and use custom server options - [ ] Test starting/stopping the local API server with different Model/Model settings - [ ] Server logs captured with correct Server Options provided - [ ] Verify functionality of Open logs/Clear feature From f8d970401a97da23620b6a6e783cf10e474c1f4b Mon Sep 17 00:00:00 2001 From: hiro Date: Tue, 19 Mar 2024 10:19:55 +0700 Subject: [PATCH 2/4] chore: Update head metadata --- README.md | 1 + docs/docs/about/2035.mdx | 14 ++++++++++++ docs/docs/about/about.md | 14 ++++++++++++ docs/docs/about/faq.md | 18 +++++++++++++++ docs/docs/about/roadmap.md | 16 +++++++++++++- docs/docs/acknowledgements.md | 13 +++++++++++ docs/docs/community/community.mdx | 14 ++++++++++++ .../01-your-first-assistant.md | 15 ++++++++++++- .../05-framework/03-engineering/assistants.md | 15 ++++++++++++- .../05-framework/03-engineering/chats.md | 13 +++++++++++ .../05-framework/03-engineering/engine.md | 13 +++++++++++ .../05-framework/03-engineering/files.md | 15 ++++++++++++- .../05-framework/03-engineering/messages.md | 13 +++++++++++ .../05-framework/03-engineering/models.md | 13 +++++++++++ .../05-framework/03-engineering/threads.md | 13 +++++++++++ .../developer/05-framework/03-product/chat.md | 13 +++++++++++ .../developer/05-framework/03-product/hub.md | 13 +++++++++++ .../developer/05-framework/03-product/jan.md | 13 +++++++++++ .../05-framework/03-product/settings.md | 13 +++++++++++ .../05-framework/03-product/system-monitor.md | 13 +++++++++++ docs/docs/events/hcmc-oct23.md | 15 ++++++++++++- docs/docs/events/nvidia-llm-day-nov-23.md | 22 ++++++++++++++----- .../advanced-settings/advanced-settings.mdx | 14 ++++++++++++ .../guides/advanced-settings/http-proxy.mdx | 13 +++++++++++ docs/docs/guides/best-practices.mdx | 12 ++++++++++ .../docs/guides/common-error/broken-build.mdx | 14 ++++++++++++ .../guides/common-error/not-using-gpu.mdx | 14 ++++++++++++ .../error-codes/how-to-get-error-logs.mdx | 14 ++++++++++++ .../error-codes/no-assistant-available.mdx | 14 ++++++++++++ .../guides/error-codes/something-amiss.mdx | 12 ++++++++++ .../error-codes/stuck-on-loading-model.mdx | 12 ++++++++++ .../error-codes/thread-disappreance.mdx | 12 ++++++++++ .../guides/error-codes/undefined-issue.mdx | 12 ++++++++++ .../guides/error-codes/unexpected-token.mdx | 12 ++++++++++ docs/docs/guides/faq.mdx | 12 ++++++++++ docs/docs/guides/install.mdx | 12 ++++++++++ docs/docs/guides/integration/azure.mdx | 12 ++++++++++ docs/docs/guides/integration/discord.mdx | 12 ++++++++++ docs/docs/guides/integration/groq.mdx | 12 ++++++++++ docs/docs/guides/integration/lmstudio.mdx | 12 ++++++++++ docs/docs/guides/integration/mistral.mdx | 12 ++++++++++ docs/docs/guides/integration/ollama.mdx | 12 ++++++++++ .../guides/integration/openinterpreter.mdx | 11 ++++++++++ docs/docs/guides/integration/openrouter.mdx | 13 ++++++++++- docs/docs/guides/integration/raycast.mdx | 11 ++++++++++ docs/docs/guides/integration/vscode.mdx | 12 ++++++++++ docs/docs/guides/models-list.mdx | 12 ++++++++++ docs/docs/guides/models/customize-engine.mdx | 12 ++++++++++ docs/docs/guides/models/import-models.mdx | 12 ++++++++++ docs/docs/guides/models/integrate-remote.mdx | 12 ++++++++++ docs/docs/guides/providers/llama-cpp.md | 14 +++++++++++- docs/docs/guides/providers/tensorrt-llm.md | 19 +++++++++++++--- docs/docs/guides/quickstart.mdx | 12 ++++++++++ docs/docs/guides/start-server.mdx | 11 ++++++++++ docs/docs/guides/thread.mdx | 11 ++++++++++ .../overview/cloud-vs-self-hosting.md | 12 ++++++++++ docs/docs/hardware/overview/cpu-vs-gpu.md | 14 ++++++++++++ docs/docs/how-we-work.md | 12 ++++++++++ docs/docs/how-we-work/analytics/analytics.md | 12 ++++++++++ docs/docs/how-we-work/engineering/qa.mdx | 12 ++++++++++ .../project-management/project-management.md | 13 ++++++++++- docs/docs/how-we-work/strategy/strategy.md | 14 +++++++++++- .../how-we-work/website-docs/website-docs.md | 12 ++++++++++ docs/docs/platforms/desktop.md | 12 ++++++++++ docs/docs/server-suite/enterprise.md | 12 ++++++++++ docs/docs/server-suite/home-server.md | 12 ++++++++++ docs/docs/team/team.md | 15 +++++++++++-- docs/docs/wall-of-love.md | 12 ++++++++++ 68 files changed, 860 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 31fa4bfc9..9e9d83fc9 100644 --- a/README.md +++ b/README.md @@ -327,6 +327,7 @@ Jan builds on top of other open-source projects: - [llama.cpp](https://github.com/ggerganov/llama.cpp) - [LangChain](https://github.com/langchain-ai) - [TensorRT](https://github.com/NVIDIA/TensorRT) +- [TensorRT-LLM](https://github.com/NVIDIA/TensorRT-LLM) ## Contact diff --git a/docs/docs/about/2035.mdx b/docs/docs/about/2035.mdx index 3af7a3197..2806e7ade 100644 --- a/docs/docs/about/2035.mdx +++ b/docs/docs/about/2035.mdx @@ -2,6 +2,20 @@ title: Jan's Vision for 2035 --- + + Jan's Vision for 2035 + + + + + + + + + + + + [Jan 2035: A Robotics Company](https://hackmd.io/QIWyYbNNQVWVbupuI3kjAA) We only have 2 planning parameters: diff --git a/docs/docs/about/about.md b/docs/docs/about/about.md index a047ab910..32f4a3e4f 100644 --- a/docs/docs/about/about.md +++ b/docs/docs/about/about.md @@ -18,6 +18,20 @@ keywords: ] --- + + About Jan + + + + + + + + + + + + Jan turns computers into thinking machines to change how we use them. Jan is created and maintained by Jan Labs, a robotics company. diff --git a/docs/docs/about/faq.md b/docs/docs/about/faq.md index 29832e211..b4e05b3a6 100644 --- a/docs/docs/about/faq.md +++ b/docs/docs/about/faq.md @@ -1,3 +1,21 @@ +--- +title: Frequently Asked Questions (FAQ) - Jan +--- + + + Frequently Asked Questions (FAQ) + + + + + + + + + + + + # Frequently Asked Questions (FAQ) ## What is Jan? diff --git a/docs/docs/about/roadmap.md b/docs/docs/about/roadmap.md index 1c789d733..d818aa647 100644 --- a/docs/docs/about/roadmap.md +++ b/docs/docs/about/roadmap.md @@ -2,5 +2,19 @@ title: Roadmap --- + + Roadmap + + + + + + + + + + + + - [ ] [Immediate Roadmap on Github](https://github.com/orgs/janhq/projects/5/views/16) -- [ ] [Longer-term Roadmap on Discord](https://discord.gg/Ey62mynnYr) \ No newline at end of file +- [ ] [Longer-term Roadmap on Discord](https://discord.gg/Ey62mynnYr) diff --git a/docs/docs/acknowledgements.md b/docs/docs/acknowledgements.md index c68c4ed86..a7f77218e 100644 --- a/docs/docs/acknowledgements.md +++ b/docs/docs/acknowledgements.md @@ -17,6 +17,18 @@ keywords: ] --- + + Acknowledgements - Jan + + + + + + + + + + # Acknowledgements We would like to express our gratitude to the following third-party libraries that have made the development of Jan possible. @@ -24,3 +36,4 @@ We would like to express our gratitude to the following third-party libraries th - [llama.cpp](https://github.com/ggerganov/llama.cpp/blob/master/LICENSE) - [LangChain.js](https://github.com/langchain-ai/langchainjs/blob/main/LICENSE) - [TensorRT](https://github.com/NVIDIA/TensorRT/blob/main/LICENSE) +- [TensorRT-LLM](https://github.com/NVIDIA/TensorRT-LLM/blob/main/LICENSE) diff --git a/docs/docs/community/community.mdx b/docs/docs/community/community.mdx index d4866490e..7c5ad9367 100644 --- a/docs/docs/community/community.mdx +++ b/docs/docs/community/community.mdx @@ -15,6 +15,20 @@ keywords: ] --- + + Jan's Community + + + + + + + + + + + + ## Socials - [Discord](https://discord.gg/SH3DGmUs6b) diff --git a/docs/docs/developer/02-build-assistant/01-your-first-assistant.md b/docs/docs/developer/02-build-assistant/01-your-first-assistant.md index 16b80fc5e..863d275fe 100644 --- a/docs/docs/developer/02-build-assistant/01-your-first-assistant.md +++ b/docs/docs/developer/02-build-assistant/01-your-first-assistant.md @@ -17,7 +17,20 @@ keywords: ] --- + + Your First Assistant + + + + + + + + + + + + :::caution This is currently under development. ::: - diff --git a/docs/docs/developer/05-framework/03-engineering/assistants.md b/docs/docs/developer/05-framework/03-engineering/assistants.md index fa9c593ab..90b52ab38 100644 --- a/docs/docs/developer/05-framework/03-engineering/assistants.md +++ b/docs/docs/developer/05-framework/03-engineering/assistants.md @@ -1,5 +1,5 @@ --- -title: "Assistants" +title: 'Assistants' description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. keywords: [ @@ -14,6 +14,19 @@ keywords: ] --- + + Assistants + + + + + + + + + + + :::caution This is currently under development. diff --git a/docs/docs/developer/05-framework/03-engineering/chats.md b/docs/docs/developer/05-framework/03-engineering/chats.md index eb0ae287a..654621e30 100644 --- a/docs/docs/developer/05-framework/03-engineering/chats.md +++ b/docs/docs/developer/05-framework/03-engineering/chats.md @@ -14,6 +14,19 @@ keywords: ] --- + + Chats + + + + + + + + + + + :::caution This is currently under development. diff --git a/docs/docs/developer/05-framework/03-engineering/engine.md b/docs/docs/developer/05-framework/03-engineering/engine.md index 653576f1b..8ebfff88d 100644 --- a/docs/docs/developer/05-framework/03-engineering/engine.md +++ b/docs/docs/developer/05-framework/03-engineering/engine.md @@ -2,6 +2,19 @@ title: Engine --- + + Engine + + + + + + + + + + + :::caution Currently Under Development diff --git a/docs/docs/developer/05-framework/03-engineering/files.md b/docs/docs/developer/05-framework/03-engineering/files.md index 59ca27ec9..9f572af11 100644 --- a/docs/docs/developer/05-framework/03-engineering/files.md +++ b/docs/docs/developer/05-framework/03-engineering/files.md @@ -1,5 +1,5 @@ --- -title: "Files" +title: 'Files' description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. keywords: [ @@ -14,6 +14,19 @@ keywords: ] --- + + Files + + + + + + + + + + + :::warning Draft Specification: functionality has not been implemented yet. diff --git a/docs/docs/developer/05-framework/03-engineering/messages.md b/docs/docs/developer/05-framework/03-engineering/messages.md index 8f2497002..6ddaba45d 100644 --- a/docs/docs/developer/05-framework/03-engineering/messages.md +++ b/docs/docs/developer/05-framework/03-engineering/messages.md @@ -14,6 +14,19 @@ keywords: ] --- + + Messages + + + + + + + + + + + :::caution This is currently under development. diff --git a/docs/docs/developer/05-framework/03-engineering/models.md b/docs/docs/developer/05-framework/03-engineering/models.md index 4e4c3c604..dbe134f07 100644 --- a/docs/docs/developer/05-framework/03-engineering/models.md +++ b/docs/docs/developer/05-framework/03-engineering/models.md @@ -14,6 +14,19 @@ keywords: ] --- + + Models + + + + + + + + + + + :::caution This is currently under development. diff --git a/docs/docs/developer/05-framework/03-engineering/threads.md b/docs/docs/developer/05-framework/03-engineering/threads.md index a1cd2b4df..f8ba018f8 100644 --- a/docs/docs/developer/05-framework/03-engineering/threads.md +++ b/docs/docs/developer/05-framework/03-engineering/threads.md @@ -14,6 +14,19 @@ keywords: ] --- + + Threads + + + + + + + + + + + :::caution This is currently under development. diff --git a/docs/docs/developer/05-framework/03-product/chat.md b/docs/docs/developer/05-framework/03-product/chat.md index b0dcce2d6..3b98485b8 100644 --- a/docs/docs/developer/05-framework/03-product/chat.md +++ b/docs/docs/developer/05-framework/03-product/chat.md @@ -14,6 +14,19 @@ keywords: ] --- + + Chat + + + + + + + + + + + ## Overview A home screen for users to chat with [assistants](/docs/engineering/assistants) via conversation [threads](/docs/engineering/threads). diff --git a/docs/docs/developer/05-framework/03-product/hub.md b/docs/docs/developer/05-framework/03-product/hub.md index 7171f8378..ea8dd81a5 100644 --- a/docs/docs/developer/05-framework/03-product/hub.md +++ b/docs/docs/developer/05-framework/03-product/hub.md @@ -14,6 +14,19 @@ keywords: ] --- + + Hub + + + + + + + + + + + ## Overview The Hub is like a store for everything, where users can discover and download models, assistants, and more. diff --git a/docs/docs/developer/05-framework/03-product/jan.md b/docs/docs/developer/05-framework/03-product/jan.md index 9e8973360..b906be09d 100644 --- a/docs/docs/developer/05-framework/03-product/jan.md +++ b/docs/docs/developer/05-framework/03-product/jan.md @@ -14,6 +14,19 @@ keywords: ] --- + + Jan (The Default Assistant) + + + + + + + + + + + Jan ships with a default assistant "Jan" that lets users chat with any open source model out-of-the-box. This assistant is defined in `/jan`. It is a generic assistant to illustrate power of Jan. In the future, it will support additional features e.g. multi-assistant conversations diff --git a/docs/docs/developer/05-framework/03-product/settings.md b/docs/docs/developer/05-framework/03-product/settings.md index 514139a00..515b5e802 100644 --- a/docs/docs/developer/05-framework/03-product/settings.md +++ b/docs/docs/developer/05-framework/03-product/settings.md @@ -14,6 +14,19 @@ keywords: ] --- + + Settings + + + + + + + + + + + ## Overview A settings page for users to add extensions, configure model settings, change app appearance, add keyboard shortcuts, and a plethora of other personalizations. diff --git a/docs/docs/developer/05-framework/03-product/system-monitor.md b/docs/docs/developer/05-framework/03-product/system-monitor.md index 761d9a7bf..15dae09ea 100644 --- a/docs/docs/developer/05-framework/03-product/system-monitor.md +++ b/docs/docs/developer/05-framework/03-product/system-monitor.md @@ -14,6 +14,19 @@ keywords: ] --- + + System Monitor + + + + + + + + + + + ## Overview An activity screen to monitor system health and running models. diff --git a/docs/docs/events/hcmc-oct23.md b/docs/docs/events/hcmc-oct23.md index 73898efcd..e70329b2d 100644 --- a/docs/docs/events/hcmc-oct23.md +++ b/docs/docs/events/hcmc-oct23.md @@ -1,10 +1,23 @@ --- title: "Jan's AI Hacker House (Ho Chi Minh City)" -description: "24-27 Oct 2023, District 3, HCMC. AI-focused talks, workshops and social events. Hosted by Jan.ai" +description: '24-27 Oct 2023, District 3, HCMC. AI-focused talks, workshops and social events. Hosted by Jan.ai' slug: /events/hcmc-oct23 image: /img/hcmc-launch-party.png --- + + Jan's AI Hacker House (Ho Chi Minh City) + + + + + + + + + + + ![](/img/hcmc-launch-party.png) 🎉 Join us at our Friday Launch Party for an evening of AI talks from other builders! [(RSVP here)](https://jan-launch-party.eventbrite.sg/) 🎉 diff --git a/docs/docs/events/nvidia-llm-day-nov-23.md b/docs/docs/events/nvidia-llm-day-nov-23.md index d467dcb6e..f739fb4ff 100644 --- a/docs/docs/events/nvidia-llm-day-nov-23.md +++ b/docs/docs/events/nvidia-llm-day-nov-23.md @@ -1,21 +1,33 @@ --- -title: "Nov 23: Nvidia GenAI Day" -description: Nvidia's LLM Day +title: 'Nov 23: Nvidia GenAI Day' +description: Nvidia's LLM Day --- + + Nov 23: Nvidia GenAI Day + + + + + + + + + + + ![](/img/nvidia-llm-day-header.png) ## Nvidia GenAI Innovation Day -Jan will be at Nvidia's GenAI Innovation Day in Nov '23, focusing on Enterprise use-cases of LLMs. +Jan will be at Nvidia's GenAI Innovation Day in Nov '23, focusing on Enterprise use-cases of LLMs. ### Location -- JW Marriott Hanoi Hotel +- JW Marriott Hanoi Hotel - 8:30am November 8th 2023 - Registration: [https://gmcgroup.com.vn/nvidia-genai-event/](https://gmcgroup.com.vn/nvidia-genai-event/) ### Programme ![](/img/nvidia-llm-day.png) - diff --git a/docs/docs/guides/advanced-settings/advanced-settings.mdx b/docs/docs/guides/advanced-settings/advanced-settings.mdx index ae3244cda..1ce65867a 100644 --- a/docs/docs/guides/advanced-settings/advanced-settings.mdx +++ b/docs/docs/guides/advanced-settings/advanced-settings.mdx @@ -15,6 +15,20 @@ keywords: ] --- + + Advanced Settings + + + + + + + + + + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/docs/guides/advanced-settings/http-proxy.mdx b/docs/docs/guides/advanced-settings/http-proxy.mdx index 7b2de339c..297133aae 100644 --- a/docs/docs/guides/advanced-settings/http-proxy.mdx +++ b/docs/docs/guides/advanced-settings/http-proxy.mdx @@ -16,6 +16,19 @@ keywords: ] --- + + HTTPS Proxy + + + + + + + + + + + ## Why HTTPS Proxy? diff --git a/docs/docs/guides/best-practices.mdx b/docs/docs/guides/best-practices.mdx index 9dabef8dc..d6e8c4584 100644 --- a/docs/docs/guides/best-practices.mdx +++ b/docs/docs/guides/best-practices.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Best Practices - Jan Guides + + + + + + + + + + Jan is a versatile platform offering solutions for integrating AI locally across various platforms. This guide outlines best practices for developers, analysts, and AI enthusiasts to enhance their experience with Jan when adding AI locally to their computers. Implementing these practices will optimize the performance of AI models. ## Follow the Quickstart Guide diff --git a/docs/docs/guides/common-error/broken-build.mdx b/docs/docs/guides/common-error/broken-build.mdx index 2b3e7a128..9a8809955 100644 --- a/docs/docs/guides/common-error/broken-build.mdx +++ b/docs/docs/guides/common-error/broken-build.mdx @@ -17,6 +17,20 @@ keywords: ] --- + + Broken Build + + + + + + + + + + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/docs/guides/common-error/not-using-gpu.mdx b/docs/docs/guides/common-error/not-using-gpu.mdx index a7dd788f8..b932a6822 100644 --- a/docs/docs/guides/common-error/not-using-gpu.mdx +++ b/docs/docs/guides/common-error/not-using-gpu.mdx @@ -17,6 +17,20 @@ keywords: [ ] --- + + Troubleshooting NVIDIA GPU + + + + + + + + + + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/docs/guides/error-codes/how-to-get-error-logs.mdx b/docs/docs/guides/error-codes/how-to-get-error-logs.mdx index 045468e33..74a7508c0 100644 --- a/docs/docs/guides/error-codes/how-to-get-error-logs.mdx +++ b/docs/docs/guides/error-codes/how-to-get-error-logs.mdx @@ -17,6 +17,20 @@ keywords: ] --- + + How to Get Error Logs + + + + + + + + + + + + To get the error logs of your Jan application, follow the steps below: ### Jan Application 1. Navigate to the main dashboard. diff --git a/docs/docs/guides/error-codes/no-assistant-available.mdx b/docs/docs/guides/error-codes/no-assistant-available.mdx index 31d9a75e9..7716dc5b0 100644 --- a/docs/docs/guides/error-codes/no-assistant-available.mdx +++ b/docs/docs/guides/error-codes/no-assistant-available.mdx @@ -17,6 +17,20 @@ keywords: ] --- + + No Assistant Available + + + + + + + + + + + + When you encounter the following error message: ``` No assistant available. diff --git a/docs/docs/guides/error-codes/something-amiss.mdx b/docs/docs/guides/error-codes/something-amiss.mdx index 0975754e3..63f918441 100644 --- a/docs/docs/guides/error-codes/something-amiss.mdx +++ b/docs/docs/guides/error-codes/something-amiss.mdx @@ -4,6 +4,18 @@ sidebar_position: 4 description: A step-by-step guide to resolve an unspecified or general error. --- + + Something's Amiss + + + + + + + + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/docs/guides/error-codes/stuck-on-loading-model.mdx b/docs/docs/guides/error-codes/stuck-on-loading-model.mdx index 86a16b5fc..3c5adf035 100644 --- a/docs/docs/guides/error-codes/stuck-on-loading-model.mdx +++ b/docs/docs/guides/error-codes/stuck-on-loading-model.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Stuck on Loading Model + + + + + + + + + + ## 1. Issue: Model Loading Stuck Due To Missing Windows Management Instrumentation Command-line (WMIC) Encountering a stuck-on-loading model issue in Jan is caused by errors related to the `Windows Management Instrumentation Command-line (WMIC)` path not being included in the system's PATH environment variable. diff --git a/docs/docs/guides/error-codes/thread-disappreance.mdx b/docs/docs/guides/error-codes/thread-disappreance.mdx index 06235df56..120e8585c 100644 --- a/docs/docs/guides/error-codes/thread-disappreance.mdx +++ b/docs/docs/guides/error-codes/thread-disappreance.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Thread Disappearance + + + + + + + + + + When you encounter the error of old threads suddenly disappear. This can happen when a new, unintentional file is created in `/jan/threads`. It can be resolved through the following steps: diff --git a/docs/docs/guides/error-codes/undefined-issue.mdx b/docs/docs/guides/error-codes/undefined-issue.mdx index 223f686d1..9373044a4 100644 --- a/docs/docs/guides/error-codes/undefined-issue.mdx +++ b/docs/docs/guides/error-codes/undefined-issue.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Undefined Issue + + + + + + + + + + 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/guides/error-codes/unexpected-token.mdx b/docs/docs/guides/error-codes/unexpected-token.mdx index 4a00e447d..252cd97fa 100644 --- a/docs/docs/guides/error-codes/unexpected-token.mdx +++ b/docs/docs/guides/error-codes/unexpected-token.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Unexpected Token + + + + + + + + + + Encountering the `Unexpected token` error when initiating a chat with OpenAI models mainly caused by either your OpenAI key or where you access your OpenAI from. This issue can be solved through the following steps: 1. Obtain an OpenAI API key from [OpenAI's developer platform](https://platform.openai.com/) and integrate it into your application. diff --git a/docs/docs/guides/faq.mdx b/docs/docs/guides/faq.mdx index 7e3d7d13d..862d43620 100644 --- a/docs/docs/guides/faq.mdx +++ b/docs/docs/guides/faq.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + FAQs - Jan Guides + + + + + + + + + + ## General Issues - **Why can't I download models like Pandora 11B Q4 and Solar Instruct 10.7B Q4?** diff --git a/docs/docs/guides/install.mdx b/docs/docs/guides/install.mdx index c8dcbf3c3..11fc96685 100644 --- a/docs/docs/guides/install.mdx +++ b/docs/docs/guides/install.mdx @@ -16,6 +16,18 @@ keywords: ] --- + + Installation - Jan Guides + + + + + + + + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import installImageURL from './assets/jan-ai-download.png'; diff --git a/docs/docs/guides/integration/azure.mdx b/docs/docs/guides/integration/azure.mdx index 6c344a199..24f457d28 100644 --- a/docs/docs/guides/integration/azure.mdx +++ b/docs/docs/guides/integration/azure.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Azure OpenAI + + + + + + + + + + ## How to Integrate Azure OpenAI 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. You can integrate Azure OpenAI with Jan by following the steps below: diff --git a/docs/docs/guides/integration/discord.mdx b/docs/docs/guides/integration/discord.mdx index 5cf846883..7b91cc972 100644 --- a/docs/docs/guides/integration/discord.mdx +++ b/docs/docs/guides/integration/discord.mdx @@ -4,6 +4,18 @@ sidebar_position: 5 description: A step-by-step guide on how to integrate Jan with a Discord bot. --- + + Discord + + + + + + + + + + ## How to Integrate Discord Bot with Jan Discord bot can enhances your discord server interactions. By integrating Jan with it, you can significantly boost responsiveness and user engaggement in your discord server. diff --git a/docs/docs/guides/integration/groq.mdx b/docs/docs/guides/integration/groq.mdx index a57bf16dd..2edc1caa5 100644 --- a/docs/docs/guides/integration/groq.mdx +++ b/docs/docs/guides/integration/groq.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Groq + + + + + + + + + + ## How to Integrate Mistral AI with Jan This guide provides step-by-step instructions on integrating the Groq API with Jan, enabling users to leverage Groq's capabilities within Jan's conversational interface. diff --git a/docs/docs/guides/integration/lmstudio.mdx b/docs/docs/guides/integration/lmstudio.mdx index 33e48f33a..9b018c2a7 100644 --- a/docs/docs/guides/integration/lmstudio.mdx +++ b/docs/docs/guides/integration/lmstudio.mdx @@ -16,6 +16,18 @@ keywords: ] --- + + LM Studio + + + + + + + + + + ## How to Integrate LM Studio with Jan [LM Studio](https://lmstudio.ai/) enables you to explore, download, and run local Large Language Models (LLMs). You can integrate Jan with LM Studio using two methods: diff --git a/docs/docs/guides/integration/mistral.mdx b/docs/docs/guides/integration/mistral.mdx index a44e23205..1772fefd9 100644 --- a/docs/docs/guides/integration/mistral.mdx +++ b/docs/docs/guides/integration/mistral.mdx @@ -16,6 +16,18 @@ keywords: ] --- + + Mistral AI + + + + + + + + + + ## How to Integrate Mistral AI with Jan [Mistral AI](https://docs.mistral.ai/) provides two ways to use their Large Language Models (LLM): diff --git a/docs/docs/guides/integration/ollama.mdx b/docs/docs/guides/integration/ollama.mdx index 6c55bc856..e50431f79 100644 --- a/docs/docs/guides/integration/ollama.mdx +++ b/docs/docs/guides/integration/ollama.mdx @@ -16,6 +16,18 @@ keywords: ] --- + + Ollama + + + + + + + + + + ## How to Integrate Ollama with Jan Ollama provides you with largen language that you can run locally. There are two methods to integrate Ollama with Jan: diff --git a/docs/docs/guides/integration/openinterpreter.mdx b/docs/docs/guides/integration/openinterpreter.mdx index a844155f5..ff706a3bc 100644 --- a/docs/docs/guides/integration/openinterpreter.mdx +++ b/docs/docs/guides/integration/openinterpreter.mdx @@ -4,6 +4,17 @@ sidebar_position: 6 description: A step-by-step guide on how to integrate Jan with Open Interpreter. --- + + Open Interpreter + + + + + + + + + ## How to Integrate Open Interpreter with Jan diff --git a/docs/docs/guides/integration/openrouter.mdx b/docs/docs/guides/integration/openrouter.mdx index 2189db0d9..89e90c6d5 100644 --- a/docs/docs/guides/integration/openrouter.mdx +++ b/docs/docs/guides/integration/openrouter.mdx @@ -4,6 +4,17 @@ sidebar_position: 2 description: A step-by-step guide on how to integrate Jan with OpenRouter. --- + + OpenRouter + + + + + + + + + ## How to Integrate OpenRouter with Jan @@ -16,7 +27,7 @@ To connect Jan with OpenRouter for accessing remote Large Language Models (LLMs) 1. Find your API keys in the [OpenRouter API Key](https://openrouter.ai/keys). 2. Set the OpenRouter API key in `~/jan/engines/openai.json` file. -### Step 2: MModel Configuration +### Step 2: Model Configuration 1. Go to the directory `~/jan/models`. 2. Make a new folder called `openrouter-(modelname)`, like `openrouter-dolphin-mixtral-8x7b`. diff --git a/docs/docs/guides/integration/raycast.mdx b/docs/docs/guides/integration/raycast.mdx index a626b0061..c9cb092b7 100644 --- a/docs/docs/guides/integration/raycast.mdx +++ b/docs/docs/guides/integration/raycast.mdx @@ -4,6 +4,17 @@ sidebar_position: 4 description: A step-by-step guide on how to integrate Jan with Raycast. --- + + Raycast + + + + + + + + + ## How to Integrate Raycast [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. To integrate Raycast with Jan, follow the steps below: diff --git a/docs/docs/guides/integration/vscode.mdx b/docs/docs/guides/integration/vscode.mdx index 0bc112186..e40f91a78 100644 --- a/docs/docs/guides/integration/vscode.mdx +++ b/docs/docs/guides/integration/vscode.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Continue + + + + + + + + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/docs/guides/models-list.mdx b/docs/docs/guides/models-list.mdx index cd7107a92..149d73733 100644 --- a/docs/docs/guides/models-list.mdx +++ b/docs/docs/guides/models-list.mdx @@ -3,6 +3,18 @@ title: Pre-configured Models sidebar_position: 3 --- + + Pre-configured Models - Jan Guides + + + + + + + + + + ## Overview Jan provides various pre-configured AI models with different capabilities. Please see the following list for details. diff --git a/docs/docs/guides/models/customize-engine.mdx b/docs/docs/guides/models/customize-engine.mdx index 2f54204a8..440e02243 100644 --- a/docs/docs/guides/models/customize-engine.mdx +++ b/docs/docs/guides/models/customize-engine.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Customize Engine Settings + + + + + + + + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/docs/guides/models/import-models.mdx b/docs/docs/guides/models/import-models.mdx index 9ed8953c7..a1f333db8 100644 --- a/docs/docs/guides/models/import-models.mdx +++ b/docs/docs/guides/models/import-models.mdx @@ -17,6 +17,18 @@ keywords: ] --- + + Manual Import + + + + + + + + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import janModel from './assets/jan-model-hub.png'; diff --git a/docs/docs/guides/models/integrate-remote.mdx b/docs/docs/guides/models/integrate-remote.mdx index af881f999..c99d7b98f 100644 --- a/docs/docs/guides/models/integrate-remote.mdx +++ b/docs/docs/guides/models/integrate-remote.mdx @@ -18,6 +18,18 @@ keywords: ] --- + + Remote Server Integration + + + + + + + + + + This guide will show you how to configure Jan as a client and point it to any remote & local (self-hosted) API server. ## OpenAI Platform Configuration diff --git a/docs/docs/guides/providers/llama-cpp.md b/docs/docs/guides/providers/llama-cpp.md index d2b0daa2a..8d9db5398 100644 --- a/docs/docs/guides/providers/llama-cpp.md +++ b/docs/docs/guides/providers/llama-cpp.md @@ -3,8 +3,20 @@ title: llama.cpp slug: /guides/providers/llama-cpp --- + + llama.cpp - Jan Guides + + + + + + + + + + ## Overview [Nitro](https://github.com/janhq/nitro) is an inference server on top of [llama.cpp](https://github.com/ggerganov/llama.cpp). It provides an OpenAI-compatible API, queue, & scaling. -Nitro is the default AI engine downloaded with Jan. There is no additional setup needed. \ No newline at end of file +Nitro is the default AI engine downloaded with Jan. There is no additional setup needed. diff --git a/docs/docs/guides/providers/tensorrt-llm.md b/docs/docs/guides/providers/tensorrt-llm.md index 52da83b36..b30d3510f 100644 --- a/docs/docs/guides/providers/tensorrt-llm.md +++ b/docs/docs/guides/providers/tensorrt-llm.md @@ -3,11 +3,23 @@ title: TensorRT-LLM slug: /guides/providers/tensorrt-llm --- + + TensorRT-LLM - Jan Guides + + + + + + + + + + Users with Nvidia GPUs can get **20-40% faster\* token speeds** on their laptop or desktops by using [TensorRT-LLM](https://github.com/NVIDIA/TensorRT-LLM). The greater implication is that you are running FP16, which is also more accurate than quantized models. This guide walks you through how to install Jan's official [TensorRT-LLM Extension](https://github.com/janhq/nitro-tensorrt-llm). This extension uses [Nitro-TensorRT-LLM](https://github.com/janhq/nitro-tensorrt-llm) as the AI engine, instead of the default [Nitro-Llama-CPP](https://github.com/janhq/nitro). It includes an efficient C++ server to natively execute the [TRT-LLM C++ runtime](https://nvidia.github.io/TensorRT-LLM/gpt_runtime.html). It also comes with additional feature and performance improvements like OpenAI compatibility, tokenizer improvements, and queues. -*Compared to using LlamaCPP engine. +\*Compared to using LlamaCPP engine. :::warning This feature is only available for Windows users. Linux is coming soon. @@ -37,6 +49,7 @@ ls ~\jan\extensions\@janhq\tensorrt-llm-extension\dist\bin ``` ## Download a Compatible Model + TensorRT-LLM can only run models in `TensorRT` format. These models, aka "TensorRT Engines", are prebuilt specifically for each target OS+GPU architecture. We offer a handful of precompiled models for Ampere and Ada cards that you can immediately download and play with: @@ -47,7 +60,7 @@ We offer a handful of precompiled models for Ampere and Ada cards that you can i ![image](https://hackmd.io/_uploads/rJewrEgRp.png) 3. Click use and start chatting! -4. You may need to allow Nitro in your network +4. You may need to allow Nitro in your network ![alt text](image.png) @@ -57,7 +70,7 @@ If you are our nightly builds, you may have to reinstall the TensorRT-LLM extens ## Configure Settings -You can customize the default parameters for how Jan runs TensorRT-LLM. +You can customize the default parameters for how Jan runs TensorRT-LLM. :::info coming soon diff --git a/docs/docs/guides/quickstart.mdx b/docs/docs/guides/quickstart.mdx index 84612716a..4ef86b589 100644 --- a/docs/docs/guides/quickstart.mdx +++ b/docs/docs/guides/quickstart.mdx @@ -16,6 +16,18 @@ keywords: ] --- + + Quickstart - Jan Docs + + + + + + + + + + import installImageURL from './assets/jan-ai-quickstart.png'; import flow from './assets/quick.png'; diff --git a/docs/docs/guides/start-server.mdx b/docs/docs/guides/start-server.mdx index d293bc646..2ae72c92b 100644 --- a/docs/docs/guides/start-server.mdx +++ b/docs/docs/guides/start-server.mdx @@ -4,6 +4,17 @@ sidebar_position: 4 description: A step-by-step guide to start Jan Local Server. --- + + Local Server - Jan Docs + + + + + + + + + Jan provides a built-in API server that can be used as a drop-in for OpenAI's API local replacement. This guide will walk you through on how to start the local server and use it to make request to the local server. diff --git a/docs/docs/guides/thread.mdx b/docs/docs/guides/thread.mdx index fdd8fb603..57f036bef 100644 --- a/docs/docs/guides/thread.mdx +++ b/docs/docs/guides/thread.mdx @@ -5,6 +5,17 @@ hide_table_of_contents: true description: Manage your interaction with AI locally. --- + + Thread Management - Jan Docs + + + + + + + + + Jan provides a straightforward and private solution for managing your threads with AI on your own device. As you interact with AI using Jan, you'll accumulate a history of threads. Jan offers easy tools to organize, delete, or review your past threads with AI. This guide will show you how to keep your threads private and well-organized. diff --git a/docs/docs/hardware/overview/cloud-vs-self-hosting.md b/docs/docs/hardware/overview/cloud-vs-self-hosting.md index 0d34bb1a9..8a24ed5af 100644 --- a/docs/docs/hardware/overview/cloud-vs-self-hosting.md +++ b/docs/docs/hardware/overview/cloud-vs-self-hosting.md @@ -2,6 +2,18 @@ title: Cloud vs. Self-hosting Your AI --- + + Cloud vs. Self-hosting Your AI + + + + + + + + + + The choice of how to run your AI - on GPU cloud services, on-prem, or just using an API provider - involves various trade-offs. The following is a naive exploration of the pros and cons of renting vs self-hosting. ## Cost Comparison diff --git a/docs/docs/hardware/overview/cpu-vs-gpu.md b/docs/docs/hardware/overview/cpu-vs-gpu.md index f0f20d8d6..e22dc43dc 100644 --- a/docs/docs/hardware/overview/cpu-vs-gpu.md +++ b/docs/docs/hardware/overview/cpu-vs-gpu.md @@ -2,6 +2,20 @@ title: GPU vs CPU What's the Difference? --- + + GPU vs CPU What's the Difference? + + + + + + + + + + + + ## CPU vs. GPU | | CPU | GPU | diff --git a/docs/docs/how-we-work.md b/docs/docs/how-we-work.md index e81099d18..20f3fb685 100644 --- a/docs/docs/how-we-work.md +++ b/docs/docs/how-we-work.md @@ -2,6 +2,18 @@ title: How We Work --- + + How We Work - Jan + + + + + + + + + + ### Open Source Jan is a startup with an open source business model. We believe in the need for an open source AI ecosystem, and are committed to building it. diff --git a/docs/docs/how-we-work/analytics/analytics.md b/docs/docs/how-we-work/analytics/analytics.md index 79e107a83..a2333a13a 100644 --- a/docs/docs/how-we-work/analytics/analytics.md +++ b/docs/docs/how-we-work/analytics/analytics.md @@ -2,6 +2,18 @@ title: Analytics --- + + Analytics + + + + + + + + + + Adhering to Jan's privacy preserving philosophy, our analytics philosophy is to get "barely-enough-to-function'. #### What is tracked diff --git a/docs/docs/how-we-work/engineering/qa.mdx b/docs/docs/how-we-work/engineering/qa.mdx index f43caae4a..43abdc12a 100644 --- a/docs/docs/how-we-work/engineering/qa.mdx +++ b/docs/docs/how-we-work/engineering/qa.mdx @@ -15,6 +15,18 @@ keywords: ] --- + + QA + + + + + + + + + + ### Phase 1: Planning #### Definition of Ready (DoR): diff --git a/docs/docs/how-we-work/project-management/project-management.md b/docs/docs/how-we-work/project-management/project-management.md index 58af4a0d3..d7429b66e 100644 --- a/docs/docs/how-we-work/project-management/project-management.md +++ b/docs/docs/how-we-work/project-management/project-management.md @@ -2,6 +2,18 @@ title: Project Management --- + + Project Management + + + + + + + + + + We use the [Jan Monorepo Project](https://github.com/orgs/janhq/projects/5) in Github to manage our roadmap and sprint Kanbans. As much as possible, everyone owns their respective `epics` and `tasks`. @@ -58,7 +70,6 @@ We aim to always sprint on `tasks` that are a part of the [current roadmap](http - `Urgent bugs`: assign to an owner (or @engineers if you are not sure) && tag the current `sprint` & `milestone` - `All else`: assign the correct roadmap `label(s)` and owner (if any) - #### Request for help As a result, our feature prioritization can feel a bit black box at times. diff --git a/docs/docs/how-we-work/strategy/strategy.md b/docs/docs/how-we-work/strategy/strategy.md index 09d9b9fb4..c0dc5c44c 100644 --- a/docs/docs/how-we-work/strategy/strategy.md +++ b/docs/docs/how-we-work/strategy/strategy.md @@ -2,7 +2,20 @@ title: Strategy --- + + Strategy + + + + + + + + + + We only have 2 planning parameters: + - 10 year vision - 2 week sprint - Quarterly OKRs @@ -46,7 +59,6 @@ Jan is a seamless user experience that runs on your personal computer, that glue - We run on top of a local folder of non-proprietary files, that anyone can tinker with (yes, even other apps!) - We provide open formats for packaging and distributing AI to run reproducibly across devices - ## Prerequisites - [Figma](https://figma.com) diff --git a/docs/docs/how-we-work/website-docs/website-docs.md b/docs/docs/how-we-work/website-docs/website-docs.md index 19fdc1676..f2ec98e9a 100644 --- a/docs/docs/how-we-work/website-docs/website-docs.md +++ b/docs/docs/how-we-work/website-docs/website-docs.md @@ -2,6 +2,18 @@ title: Website & Docs --- + + Website & Docs + + + + + + + + + + This website is built using [Docusaurus 3.0](https://docusaurus.io/), a modern static website generator. ### Information Architecture diff --git a/docs/docs/platforms/desktop.md b/docs/docs/platforms/desktop.md index fb4ea8389..d2b0efce5 100644 --- a/docs/docs/platforms/desktop.md +++ b/docs/docs/platforms/desktop.md @@ -15,6 +15,18 @@ keywords: ] --- + + Jan Desktop + + + + + + + + + + # Turn any computer into an AI computer ![Alt text](image.png) diff --git a/docs/docs/server-suite/enterprise.md b/docs/docs/server-suite/enterprise.md index 565c14fde..1823bfddd 100644 --- a/docs/docs/server-suite/enterprise.md +++ b/docs/docs/server-suite/enterprise.md @@ -15,6 +15,18 @@ keywords: ] --- + + Jan Enterprise + + + + + + + + + + # Customize and run AI across your organization Jan can professional backend to create, customize and run AIs at scale, for production-grade data centers. diff --git a/docs/docs/server-suite/home-server.md b/docs/docs/server-suite/home-server.md index 97f3afbc7..9e766564c 100644 --- a/docs/docs/server-suite/home-server.md +++ b/docs/docs/server-suite/home-server.md @@ -15,6 +15,18 @@ keywords: ] --- + + Jan Home Server + + + + + + + + + + # Customize and run AI across all of your devices Self-host and access your AI from anywhere with Jan server suite. diff --git a/docs/docs/team/team.md b/docs/docs/team/team.md index 7d5e07cfb..e6ef906f1 100644 --- a/docs/docs/team/team.md +++ b/docs/docs/team/team.md @@ -2,6 +2,18 @@ title: Who we are --- + + Who we are - Jan + + + + + + + + + + What's Jan the company about? We aim to build the cognitive framework for future robots @@ -13,7 +25,6 @@ Jan is a startup with an open source business model. We believe in the need for - [Jan Desktop Client & Local server](https://jan.ai) (AGPLv3, built on Jan Framework) - [Nitro: run Local AI](https://github.com/janhq/nitro) (AGPLv3) - ### Bootstrapped Jan is currently a bootstrapped startup. @@ -25,4 +36,4 @@ We balance technical invention with the search for a sustainable business model. ## Our Team - Contributors -- Core Team \ No newline at end of file +- Core Team diff --git a/docs/docs/wall-of-love.md b/docs/docs/wall-of-love.md index f6bfe79d8..7d130f373 100644 --- a/docs/docs/wall-of-love.md +++ b/docs/docs/wall-of-love.md @@ -2,6 +2,18 @@ title: Wall of Love ❤️ --- + + Wall of Love ❤️ - Jan + + + + + + + + + + ## Twitter Check out our amazing users and what they are saying about Jan! From 5edc6e429c24a635433066d6b0e6f4af54ce8802 Mon Sep 17 00:00:00 2001 From: hiro Date: Tue, 19 Mar 2024 10:47:24 +0700 Subject: [PATCH 3/4] fix: metadata end tag --- docs/docs/acknowledgements.md | 17 +++---- .../advanced-settings/advanced-settings.mdx | 20 ++++---- .../guides/advanced-settings/http-proxy.mdx | 20 ++++---- docs/docs/guides/best-practices.mdx | 16 +++--- .../docs/guides/common-error/broken-build.mdx | 20 ++++---- .../guides/common-error/not-using-gpu.mdx | 20 ++++---- .../error-codes/how-to-get-error-logs.mdx | 20 ++++---- .../error-codes/no-assistant-available.mdx | 20 ++++---- .../guides/error-codes/something-amiss.mdx | 16 +++--- .../error-codes/stuck-on-loading-model.mdx | 16 +++--- .../error-codes/thread-disappreance.mdx | 16 +++--- .../guides/error-codes/undefined-issue.mdx | 16 +++--- .../guides/error-codes/unexpected-token.mdx | 16 +++--- docs/docs/guides/faq.mdx | 16 +++--- docs/docs/guides/install.mdx | 16 +++--- docs/docs/guides/integration/azure.mdx | 16 +++--- docs/docs/guides/integration/discord.mdx | 16 +++--- docs/docs/guides/integration/groq.mdx | 16 +++--- docs/docs/guides/integration/lmstudio.mdx | 16 +++--- docs/docs/guides/integration/mistral.mdx | 16 +++--- docs/docs/guides/integration/ollama.mdx | 16 +++--- .../guides/integration/openinterpreter.mdx | 16 +++--- docs/docs/guides/integration/openrouter.mdx | 16 +++--- docs/docs/guides/integration/raycast.mdx | 16 +++--- docs/docs/guides/integration/vscode.mdx | 16 +++--- docs/docs/guides/models-list.mdx | 16 +++--- docs/docs/guides/models/customize-engine.mdx | 16 +++--- docs/docs/guides/models/import-models.mdx | 16 +++--- docs/docs/guides/models/integrate-remote.mdx | 16 +++--- docs/docs/guides/providers/llama-cpp.md | 16 +++--- docs/docs/guides/providers/tensorrt-llm.md | 16 +++--- docs/docs/guides/quickstart.mdx | 16 +++--- docs/docs/guides/start-server.mdx | 16 +++--- docs/docs/guides/thread.mdx | 16 +++--- .../overview/cloud-vs-self-hosting.md | 16 +++--- docs/docs/hardware/overview/cpu-vs-gpu.md | 20 ++++---- docs/docs/how-we-work.md | 16 +++--- docs/docs/how-we-work/analytics/analytics.md | 16 +++--- docs/docs/how-we-work/engineering/qa.mdx | 16 +++--- .../project-management/project-management.md | 16 +++--- docs/docs/how-we-work/strategy/strategy.md | 16 +++--- .../how-we-work/website-docs/website-docs.md | 16 +++--- docs/docs/platforms/desktop.md | 16 +++--- docs/docs/server-suite/enterprise.md | 16 +++--- docs/docs/server-suite/home-server.md | 16 +++--- docs/docs/team/team.md | 16 +++--- docs/docs/template/QA_script.md | 51 ------------------- docs/docs/wall-of-love.md | 16 +++--- 48 files changed, 390 insertions(+), 442 deletions(-) diff --git a/docs/docs/acknowledgements.md b/docs/docs/acknowledgements.md index a7f77218e..6807d90fd 100644 --- a/docs/docs/acknowledgements.md +++ b/docs/docs/acknowledgements.md @@ -18,15 +18,14 @@ keywords: --- - Acknowledgements - Jan - - - - - - - - + + + + + + + + # Acknowledgements diff --git a/docs/docs/guides/advanced-settings/advanced-settings.mdx b/docs/docs/guides/advanced-settings/advanced-settings.mdx index 1ce65867a..7099843ca 100644 --- a/docs/docs/guides/advanced-settings/advanced-settings.mdx +++ b/docs/docs/guides/advanced-settings/advanced-settings.mdx @@ -17,16 +17,16 @@ keywords: Advanced Settings - - - - - - - - - - + + + + + + + + + + import Tabs from '@theme/Tabs'; diff --git a/docs/docs/guides/advanced-settings/http-proxy.mdx b/docs/docs/guides/advanced-settings/http-proxy.mdx index 297133aae..c3e3b0b52 100644 --- a/docs/docs/guides/advanced-settings/http-proxy.mdx +++ b/docs/docs/guides/advanced-settings/http-proxy.mdx @@ -18,16 +18,16 @@ keywords: HTTPS Proxy - - - - - - - - - - + + + + + + + + + + ## Why HTTPS Proxy? diff --git a/docs/docs/guides/best-practices.mdx b/docs/docs/guides/best-practices.mdx index d6e8c4584..9f06ac68a 100644 --- a/docs/docs/guides/best-practices.mdx +++ b/docs/docs/guides/best-practices.mdx @@ -19,14 +19,14 @@ keywords: Best Practices - Jan Guides - - - - - - - - + + + + + + + + Jan is a versatile platform offering solutions for integrating AI locally across various platforms. This guide outlines best practices for developers, analysts, and AI enthusiasts to enhance their experience with Jan when adding AI locally to their computers. Implementing these practices will optimize the performance of AI models. diff --git a/docs/docs/guides/common-error/broken-build.mdx b/docs/docs/guides/common-error/broken-build.mdx index 9a8809955..39004068b 100644 --- a/docs/docs/guides/common-error/broken-build.mdx +++ b/docs/docs/guides/common-error/broken-build.mdx @@ -19,16 +19,16 @@ keywords: Broken Build - - - - - - - - - - + + + + + + + + + + import Tabs from '@theme/Tabs'; diff --git a/docs/docs/guides/common-error/not-using-gpu.mdx b/docs/docs/guides/common-error/not-using-gpu.mdx index b932a6822..d0f719919 100644 --- a/docs/docs/guides/common-error/not-using-gpu.mdx +++ b/docs/docs/guides/common-error/not-using-gpu.mdx @@ -19,16 +19,16 @@ keywords: [ Troubleshooting NVIDIA GPU - - - - - - - - - - + + + + + + + + + + import Tabs from '@theme/Tabs'; diff --git a/docs/docs/guides/error-codes/how-to-get-error-logs.mdx b/docs/docs/guides/error-codes/how-to-get-error-logs.mdx index 74a7508c0..03c6ec87c 100644 --- a/docs/docs/guides/error-codes/how-to-get-error-logs.mdx +++ b/docs/docs/guides/error-codes/how-to-get-error-logs.mdx @@ -19,16 +19,16 @@ keywords: How to Get Error Logs - - - - - - - - - - + + + + + + + + + + To get the error logs of your Jan application, follow the steps below: diff --git a/docs/docs/guides/error-codes/no-assistant-available.mdx b/docs/docs/guides/error-codes/no-assistant-available.mdx index 7716dc5b0..2d298aca0 100644 --- a/docs/docs/guides/error-codes/no-assistant-available.mdx +++ b/docs/docs/guides/error-codes/no-assistant-available.mdx @@ -19,16 +19,16 @@ keywords: No Assistant Available - - - - - - - - - - + + + + + + + + + + When you encounter the following error message: diff --git a/docs/docs/guides/error-codes/something-amiss.mdx b/docs/docs/guides/error-codes/something-amiss.mdx index 63f918441..8ecaeacf3 100644 --- a/docs/docs/guides/error-codes/something-amiss.mdx +++ b/docs/docs/guides/error-codes/something-amiss.mdx @@ -6,14 +6,14 @@ description: A step-by-step guide to resolve an unspecified or general error. Something's Amiss - - - - - - - - + + + + + + + + import Tabs from '@theme/Tabs'; diff --git a/docs/docs/guides/error-codes/stuck-on-loading-model.mdx b/docs/docs/guides/error-codes/stuck-on-loading-model.mdx index 3c5adf035..80f55d403 100644 --- a/docs/docs/guides/error-codes/stuck-on-loading-model.mdx +++ b/docs/docs/guides/error-codes/stuck-on-loading-model.mdx @@ -19,14 +19,14 @@ keywords: Stuck on Loading Model - - - - - - - - + + + + + + + + ## 1. Issue: Model Loading Stuck Due To Missing Windows Management Instrumentation Command-line (WMIC) diff --git a/docs/docs/guides/error-codes/thread-disappreance.mdx b/docs/docs/guides/error-codes/thread-disappreance.mdx index 120e8585c..ef8c35f64 100644 --- a/docs/docs/guides/error-codes/thread-disappreance.mdx +++ b/docs/docs/guides/error-codes/thread-disappreance.mdx @@ -19,14 +19,14 @@ keywords: Thread Disappearance - - - - - - - - + + + + + + + + When you encounter the error of old threads suddenly disappear. This can happen when a new, unintentional file is created in `/jan/threads`. diff --git a/docs/docs/guides/error-codes/undefined-issue.mdx b/docs/docs/guides/error-codes/undefined-issue.mdx index 9373044a4..5f4281155 100644 --- a/docs/docs/guides/error-codes/undefined-issue.mdx +++ b/docs/docs/guides/error-codes/undefined-issue.mdx @@ -19,14 +19,14 @@ keywords: Undefined Issue - - - - - - - - + + + + + + + + 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: diff --git a/docs/docs/guides/error-codes/unexpected-token.mdx b/docs/docs/guides/error-codes/unexpected-token.mdx index 252cd97fa..28f69af51 100644 --- a/docs/docs/guides/error-codes/unexpected-token.mdx +++ b/docs/docs/guides/error-codes/unexpected-token.mdx @@ -19,14 +19,14 @@ keywords: Unexpected Token - - - - - - - - + + + + + + + + Encountering the `Unexpected token` error when initiating a chat with OpenAI models mainly caused by either your OpenAI key or where you access your OpenAI from. This issue can be solved through the following steps: diff --git a/docs/docs/guides/faq.mdx b/docs/docs/guides/faq.mdx index 862d43620..f1d1fca2c 100644 --- a/docs/docs/guides/faq.mdx +++ b/docs/docs/guides/faq.mdx @@ -19,14 +19,14 @@ keywords: FAQs - Jan Guides - - - - - - - - + + + + + + + + ## General Issues diff --git a/docs/docs/guides/install.mdx b/docs/docs/guides/install.mdx index 11fc96685..b64469411 100644 --- a/docs/docs/guides/install.mdx +++ b/docs/docs/guides/install.mdx @@ -18,14 +18,14 @@ keywords: Installation - Jan Guides - - - - - - - - + + + + + + + + import Tabs from '@theme/Tabs'; diff --git a/docs/docs/guides/integration/azure.mdx b/docs/docs/guides/integration/azure.mdx index 24f457d28..71f070ffb 100644 --- a/docs/docs/guides/integration/azure.mdx +++ b/docs/docs/guides/integration/azure.mdx @@ -19,14 +19,14 @@ keywords: Azure OpenAI - - - - - - - - + + + + + + + + ## How to Integrate Azure OpenAI with Jan diff --git a/docs/docs/guides/integration/discord.mdx b/docs/docs/guides/integration/discord.mdx index 7b91cc972..9bff868d9 100644 --- a/docs/docs/guides/integration/discord.mdx +++ b/docs/docs/guides/integration/discord.mdx @@ -6,14 +6,14 @@ description: A step-by-step guide on how to integrate Jan with a Discord bot. Discord - - - - - - - - + + + + + + + + ## How to Integrate Discord Bot with Jan diff --git a/docs/docs/guides/integration/groq.mdx b/docs/docs/guides/integration/groq.mdx index 2edc1caa5..db97461a7 100644 --- a/docs/docs/guides/integration/groq.mdx +++ b/docs/docs/guides/integration/groq.mdx @@ -19,14 +19,14 @@ keywords: Groq - - - - - - - - + + + + + + + + ## How to Integrate Mistral AI with Jan diff --git a/docs/docs/guides/integration/lmstudio.mdx b/docs/docs/guides/integration/lmstudio.mdx index 9b018c2a7..058c2df49 100644 --- a/docs/docs/guides/integration/lmstudio.mdx +++ b/docs/docs/guides/integration/lmstudio.mdx @@ -18,14 +18,14 @@ keywords: LM Studio - - - - - - - - + + + + + + + + ## How to Integrate LM Studio with Jan diff --git a/docs/docs/guides/integration/mistral.mdx b/docs/docs/guides/integration/mistral.mdx index 1772fefd9..200713422 100644 --- a/docs/docs/guides/integration/mistral.mdx +++ b/docs/docs/guides/integration/mistral.mdx @@ -18,14 +18,14 @@ keywords: Mistral AI - - - - - - - - + + + + + + + + ## How to Integrate Mistral AI with Jan diff --git a/docs/docs/guides/integration/ollama.mdx b/docs/docs/guides/integration/ollama.mdx index e50431f79..bbf6cc826 100644 --- a/docs/docs/guides/integration/ollama.mdx +++ b/docs/docs/guides/integration/ollama.mdx @@ -18,14 +18,14 @@ keywords: Ollama - - - - - - - - + + + + + + + + ## How to Integrate Ollama with Jan diff --git a/docs/docs/guides/integration/openinterpreter.mdx b/docs/docs/guides/integration/openinterpreter.mdx index ff706a3bc..a637736dc 100644 --- a/docs/docs/guides/integration/openinterpreter.mdx +++ b/docs/docs/guides/integration/openinterpreter.mdx @@ -6,14 +6,14 @@ description: A step-by-step guide on how to integrate Jan with Open Interpreter. Open Interpreter - - - - - - - - + + + + + + + + ## How to Integrate Open Interpreter with Jan diff --git a/docs/docs/guides/integration/openrouter.mdx b/docs/docs/guides/integration/openrouter.mdx index 89e90c6d5..01f8077ba 100644 --- a/docs/docs/guides/integration/openrouter.mdx +++ b/docs/docs/guides/integration/openrouter.mdx @@ -6,14 +6,14 @@ description: A step-by-step guide on how to integrate Jan with OpenRouter. OpenRouter - - - - - - - - + + + + + + + + ## How to Integrate OpenRouter with Jan diff --git a/docs/docs/guides/integration/raycast.mdx b/docs/docs/guides/integration/raycast.mdx index c9cb092b7..4e255872b 100644 --- a/docs/docs/guides/integration/raycast.mdx +++ b/docs/docs/guides/integration/raycast.mdx @@ -6,14 +6,14 @@ description: A step-by-step guide on how to integrate Jan with Raycast. Raycast - - - - - - - - + + + + + + + + ## How to Integrate Raycast diff --git a/docs/docs/guides/integration/vscode.mdx b/docs/docs/guides/integration/vscode.mdx index e40f91a78..75c477e15 100644 --- a/docs/docs/guides/integration/vscode.mdx +++ b/docs/docs/guides/integration/vscode.mdx @@ -19,14 +19,14 @@ keywords: Continue - - - - - - - - + + + + + + + + import Tabs from '@theme/Tabs'; diff --git a/docs/docs/guides/models-list.mdx b/docs/docs/guides/models-list.mdx index 149d73733..48f6c7ba5 100644 --- a/docs/docs/guides/models-list.mdx +++ b/docs/docs/guides/models-list.mdx @@ -5,14 +5,14 @@ sidebar_position: 3 Pre-configured Models - Jan Guides - - - - - - - - + + + + + + + + ## Overview diff --git a/docs/docs/guides/models/customize-engine.mdx b/docs/docs/guides/models/customize-engine.mdx index 440e02243..9f3eb5eb9 100644 --- a/docs/docs/guides/models/customize-engine.mdx +++ b/docs/docs/guides/models/customize-engine.mdx @@ -19,14 +19,14 @@ keywords: Customize Engine Settings - - - - - - - - + + + + + + + + import Tabs from '@theme/Tabs'; diff --git a/docs/docs/guides/models/import-models.mdx b/docs/docs/guides/models/import-models.mdx index a1f333db8..5f1a75ab5 100644 --- a/docs/docs/guides/models/import-models.mdx +++ b/docs/docs/guides/models/import-models.mdx @@ -19,14 +19,14 @@ keywords: Manual Import - - - - - - - - + + + + + + + + import Tabs from '@theme/Tabs'; diff --git a/docs/docs/guides/models/integrate-remote.mdx b/docs/docs/guides/models/integrate-remote.mdx index c99d7b98f..46e2bf508 100644 --- a/docs/docs/guides/models/integrate-remote.mdx +++ b/docs/docs/guides/models/integrate-remote.mdx @@ -20,14 +20,14 @@ keywords: Remote Server Integration - - - - - - - - + + + + + + + + This guide will show you how to configure Jan as a client and point it to any remote & local (self-hosted) API server. diff --git a/docs/docs/guides/providers/llama-cpp.md b/docs/docs/guides/providers/llama-cpp.md index 8d9db5398..0116973bd 100644 --- a/docs/docs/guides/providers/llama-cpp.md +++ b/docs/docs/guides/providers/llama-cpp.md @@ -5,14 +5,14 @@ slug: /guides/providers/llama-cpp llama.cpp - Jan Guides - - - - - - - - + + + + + + + + ## Overview diff --git a/docs/docs/guides/providers/tensorrt-llm.md b/docs/docs/guides/providers/tensorrt-llm.md index b30d3510f..ad37c1969 100644 --- a/docs/docs/guides/providers/tensorrt-llm.md +++ b/docs/docs/guides/providers/tensorrt-llm.md @@ -5,14 +5,14 @@ slug: /guides/providers/tensorrt-llm TensorRT-LLM - Jan Guides - - - - - - - - + + + + + + + + Users with Nvidia GPUs can get **20-40% faster\* token speeds** on their laptop or desktops by using [TensorRT-LLM](https://github.com/NVIDIA/TensorRT-LLM). The greater implication is that you are running FP16, which is also more accurate than quantized models. diff --git a/docs/docs/guides/quickstart.mdx b/docs/docs/guides/quickstart.mdx index 4ef86b589..e0702b0eb 100644 --- a/docs/docs/guides/quickstart.mdx +++ b/docs/docs/guides/quickstart.mdx @@ -18,14 +18,14 @@ keywords: Quickstart - Jan Docs - - - - - - - - + + + + + + + + import installImageURL from './assets/jan-ai-quickstart.png'; diff --git a/docs/docs/guides/start-server.mdx b/docs/docs/guides/start-server.mdx index 2ae72c92b..741eb2ffc 100644 --- a/docs/docs/guides/start-server.mdx +++ b/docs/docs/guides/start-server.mdx @@ -6,14 +6,14 @@ description: A step-by-step guide to start Jan Local Server. Local Server - Jan Docs - - - - - - - - + + + + + + + + Jan provides a built-in API server that can be used as a drop-in for OpenAI's API local replacement. This guide will walk you through on how to start the local server and use it to make request to the local server. diff --git a/docs/docs/guides/thread.mdx b/docs/docs/guides/thread.mdx index 57f036bef..cb6940a89 100644 --- a/docs/docs/guides/thread.mdx +++ b/docs/docs/guides/thread.mdx @@ -7,14 +7,14 @@ description: Manage your interaction with AI locally. Thread Management - Jan Docs - - - - - - - - + + + + + + + + Jan provides a straightforward and private solution for managing your threads with AI on your own device. As you interact with AI using Jan, you'll accumulate a history of threads. diff --git a/docs/docs/hardware/overview/cloud-vs-self-hosting.md b/docs/docs/hardware/overview/cloud-vs-self-hosting.md index 8a24ed5af..8452d6967 100644 --- a/docs/docs/hardware/overview/cloud-vs-self-hosting.md +++ b/docs/docs/hardware/overview/cloud-vs-self-hosting.md @@ -4,14 +4,14 @@ title: Cloud vs. Self-hosting Your AI Cloud vs. Self-hosting Your AI - - - - - - - - + + + + + + + + The choice of how to run your AI - on GPU cloud services, on-prem, or just using an API provider - involves various trade-offs. The following is a naive exploration of the pros and cons of renting vs self-hosting. diff --git a/docs/docs/hardware/overview/cpu-vs-gpu.md b/docs/docs/hardware/overview/cpu-vs-gpu.md index e22dc43dc..7ebd327b4 100644 --- a/docs/docs/hardware/overview/cpu-vs-gpu.md +++ b/docs/docs/hardware/overview/cpu-vs-gpu.md @@ -4,16 +4,16 @@ title: GPU vs CPU What's the Difference? GPU vs CPU What's the Difference? - - - - - - - - - - + + + + + + + + + + ## CPU vs. GPU diff --git a/docs/docs/how-we-work.md b/docs/docs/how-we-work.md index 20f3fb685..b8b24bdb2 100644 --- a/docs/docs/how-we-work.md +++ b/docs/docs/how-we-work.md @@ -4,14 +4,14 @@ title: How We Work How We Work - Jan - - - - - - - - + + + + + + + + ### Open Source diff --git a/docs/docs/how-we-work/analytics/analytics.md b/docs/docs/how-we-work/analytics/analytics.md index a2333a13a..e938a9734 100644 --- a/docs/docs/how-we-work/analytics/analytics.md +++ b/docs/docs/how-we-work/analytics/analytics.md @@ -4,14 +4,14 @@ title: Analytics Analytics - - - - - - - - + + + + + + + + Adhering to Jan's privacy preserving philosophy, our analytics philosophy is to get "barely-enough-to-function'. diff --git a/docs/docs/how-we-work/engineering/qa.mdx b/docs/docs/how-we-work/engineering/qa.mdx index 43abdc12a..8e10ef0b1 100644 --- a/docs/docs/how-we-work/engineering/qa.mdx +++ b/docs/docs/how-we-work/engineering/qa.mdx @@ -17,14 +17,14 @@ keywords: QA - - - - - - - - + + + + + + + + ### Phase 1: Planning diff --git a/docs/docs/how-we-work/project-management/project-management.md b/docs/docs/how-we-work/project-management/project-management.md index d7429b66e..f35a6ba77 100644 --- a/docs/docs/how-we-work/project-management/project-management.md +++ b/docs/docs/how-we-work/project-management/project-management.md @@ -4,14 +4,14 @@ title: Project Management Project Management - - - - - - - - + + + + + + + + We use the [Jan Monorepo Project](https://github.com/orgs/janhq/projects/5) in Github to manage our roadmap and sprint Kanbans. diff --git a/docs/docs/how-we-work/strategy/strategy.md b/docs/docs/how-we-work/strategy/strategy.md index c0dc5c44c..26c1ca74b 100644 --- a/docs/docs/how-we-work/strategy/strategy.md +++ b/docs/docs/how-we-work/strategy/strategy.md @@ -4,14 +4,14 @@ title: Strategy Strategy - - - - - - - - + + + + + + + + We only have 2 planning parameters: diff --git a/docs/docs/how-we-work/website-docs/website-docs.md b/docs/docs/how-we-work/website-docs/website-docs.md index f2ec98e9a..9288fa735 100644 --- a/docs/docs/how-we-work/website-docs/website-docs.md +++ b/docs/docs/how-we-work/website-docs/website-docs.md @@ -4,14 +4,14 @@ title: Website & Docs Website & Docs - - - - - - - - + + + + + + + + This website is built using [Docusaurus 3.0](https://docusaurus.io/), a modern static website generator. diff --git a/docs/docs/platforms/desktop.md b/docs/docs/platforms/desktop.md index d2b0efce5..f09013b6b 100644 --- a/docs/docs/platforms/desktop.md +++ b/docs/docs/platforms/desktop.md @@ -17,14 +17,14 @@ keywords: Jan Desktop - - - - - - - - + + + + + + + + # Turn any computer into an AI computer diff --git a/docs/docs/server-suite/enterprise.md b/docs/docs/server-suite/enterprise.md index 1823bfddd..187e97121 100644 --- a/docs/docs/server-suite/enterprise.md +++ b/docs/docs/server-suite/enterprise.md @@ -17,14 +17,14 @@ keywords: Jan Enterprise - - - - - - - - + + + + + + + + # Customize and run AI across your organization diff --git a/docs/docs/server-suite/home-server.md b/docs/docs/server-suite/home-server.md index 9e766564c..9317f2f76 100644 --- a/docs/docs/server-suite/home-server.md +++ b/docs/docs/server-suite/home-server.md @@ -17,14 +17,14 @@ keywords: Jan Home Server - - - - - - - - + + + + + + + + # Customize and run AI across all of your devices diff --git a/docs/docs/team/team.md b/docs/docs/team/team.md index e6ef906f1..3af811933 100644 --- a/docs/docs/team/team.md +++ b/docs/docs/team/team.md @@ -4,14 +4,14 @@ title: Who we are Who we are - Jan - - - - - - - - + + + + + + + + What's Jan the company about? diff --git a/docs/docs/template/QA_script.md b/docs/docs/template/QA_script.md index d0ba4b90f..de006c629 100644 --- a/docs/docs/template/QA_script.md +++ b/docs/docs/template/QA_script.md @@ -1,25 +1,5 @@ ---- -title: Jan version release template ---- - - - Release Version QA Script template - - - - - - - - - - - - # Regression test -# [Release Version] QA Script - **Release Version:** v0.4.7 **Operating System:** MacOS @@ -96,12 +76,6 @@ title: Jan version release template ### 4. Users can click on a history thread -# <<<<<<< HEAD - -- [ ] Test the ability to click on any thread in the history panel. -- [ ] :key: Verify that clicking a thread brings up the past conversation in the main chat window. -- [ ] :key: Ensure that the selected thread is highlighted or otherwise indicated in the history panel. - > > > > > > > f2847d56c (feat: Add SEO header tag with OpenAI GPT-4) - [ ] Confirm that the chat window displays the entire conversation from the selected history thread without any missing messages. - [ ] :key: Check the performance and accuracy of the history feature when dealing with a large number of threads. - [ ] Validate that historical threads reflect the exact state of the chat at that time, including settings. @@ -110,10 +84,6 @@ title: Jan version release template ### 5. Users can config instructions for the assistant. -# <<<<<<< HEAD - -- [ ] Ensure there is a clear interface to input or change instructions for the assistant. - > > > > > > > f2847d56c (feat: Add SEO header tag with OpenAI GPT-4) - [ ] Test if the instructions set by the user are being followed by the assistant in subsequent conversations. - [ ] :key: Validate that changes to instructions are updated in real time and do not require a restart of the application or session. - [ ] :key: Check for the ability to reset instructions to default or clear them completely. @@ -207,27 +177,6 @@ title: Jan version release template - [ ] :key: Test the `Experimental Mode` toggle to confirm it enables or disables experimental features as intended. - [ ] :key: Check the functionality of `Open App Directory` to ensure it opens the correct folder in the system file explorer. - <<<<<<< HEAD - ======= -- [ ] Validate that changes in advanced settings are applied immediately or provide appropriate instructions if a restart is needed. -- [ ] Test the application's stability when experimental features are enabled. - -### 4. Users can add custom plugins via manual installation [TBU] - -- [ ] Verify that the `Manual Installation` option is clearly visible and accessible in the `Extensions` section. -- [ ] Test the functionality of the `Select` button within the `Manual Installation` area. -- [ ] :warning: Check that the file picker dialog allows for the correct plugin file types (e.g., .tgz). -- [ ] :key: Validate that the selected plugin file installs correctly and the plugin becomes functional. -- [ ] Ensure that there is a progress indicator or confirmation message once the installation is complete. -- [ ] Confirm that if the installation is interrupted or fails, the user is given a clear error message. -- [ ] :key: Test that the application prevents the installation of incompatible or corrupt plugin files. -- [ ] :key: Check that the user can uninstall or disable custom plugins as easily as pre-installed ones. -- [ ] Verify that the application's performance remains stable after the installation of custom plugins. - -### 5. Advanced Settings - -- [ ] Attemp to test downloading model from hub using **HTTP Proxy** [guideline](https://github.com/janhq/jan/pull/1562) - > > > > > > > f2847d56c (feat: Add SEO header tag with OpenAI GPT-4) - [ ] Users can move **Jan data folder** - [ ] Validate that changes in advanced settings are applied immediately or provide appropriate instructions if a restart is needed. - [ ] Attemp to test downloading model from hub using **HTTP Proxy** [guideline](https://github.com/janhq/jan/pull/1562) diff --git a/docs/docs/wall-of-love.md b/docs/docs/wall-of-love.md index 7d130f373..359494162 100644 --- a/docs/docs/wall-of-love.md +++ b/docs/docs/wall-of-love.md @@ -4,14 +4,14 @@ title: Wall of Love ❤️ Wall of Love ❤️ - Jan - - - - - - - - + + + + + + + + ## Twitter From 642ee431d7cc8252ae3731d49e9a8158d54915e6 Mon Sep 17 00:00:00 2001 From: hiro Date: Tue, 19 Mar 2024 10:56:45 +0700 Subject: [PATCH 4/4] chore: Update misc --- docs/docs/acknowledgements.md | 2 +- docs/docs/guides/advanced-settings/advanced-settings.mdx | 6 +++--- docs/docs/guides/advanced-settings/http-proxy.mdx | 6 +++--- docs/docs/guides/best-practices.mdx | 2 +- docs/docs/guides/common-error/broken-build.mdx | 6 +++--- docs/docs/guides/common-error/not-using-gpu.mdx | 6 +++--- docs/docs/guides/error-codes/how-to-get-error-logs.mdx | 6 +++--- docs/docs/guides/error-codes/no-assistant-available.mdx | 6 +++--- docs/docs/guides/error-codes/something-amiss.mdx | 2 +- docs/docs/guides/error-codes/stuck-on-loading-model.mdx | 2 +- docs/docs/guides/error-codes/thread-disappreance.mdx | 2 +- docs/docs/guides/error-codes/undefined-issue.mdx | 2 +- docs/docs/guides/error-codes/unexpected-token.mdx | 2 +- docs/docs/guides/faq.mdx | 2 +- docs/docs/guides/install.mdx | 2 +- docs/docs/guides/integration/azure.mdx | 2 +- docs/docs/guides/integration/discord.mdx | 2 +- docs/docs/guides/integration/groq.mdx | 2 +- docs/docs/guides/integration/lmstudio.mdx | 2 +- docs/docs/guides/integration/mistral.mdx | 2 +- docs/docs/guides/integration/ollama.mdx | 2 +- docs/docs/guides/integration/openinterpreter.mdx | 2 +- docs/docs/guides/integration/openrouter.mdx | 2 +- docs/docs/guides/integration/raycast.mdx | 2 +- docs/docs/guides/integration/vscode.mdx | 2 +- docs/docs/guides/models-list.mdx | 2 +- docs/docs/guides/models/customize-engine.mdx | 2 +- docs/docs/guides/models/import-models.mdx | 2 +- docs/docs/guides/models/integrate-remote.mdx | 2 +- docs/docs/guides/providers/llama-cpp.md | 2 +- docs/docs/guides/providers/tensorrt-llm.md | 2 +- docs/docs/guides/quickstart.mdx | 2 +- docs/docs/guides/start-server.mdx | 2 +- docs/docs/guides/thread.mdx | 2 +- docs/docs/hardware/overview/cloud-vs-self-hosting.md | 2 +- docs/docs/hardware/overview/cpu-vs-gpu.md | 2 +- docs/docs/how-we-work.md | 2 +- docs/docs/how-we-work/analytics/analytics.md | 2 +- docs/docs/how-we-work/engineering/qa.mdx | 2 +- .../how-we-work/project-management/project-management.md | 2 +- docs/docs/how-we-work/strategy/strategy.md | 2 +- docs/docs/how-we-work/website-docs/website-docs.md | 2 +- docs/docs/platforms/desktop.md | 2 +- docs/docs/server-suite/enterprise.md | 2 +- docs/docs/server-suite/home-server.md | 2 +- docs/docs/team/team.md | 2 +- docs/docs/wall-of-love.md | 2 +- 47 files changed, 59 insertions(+), 59 deletions(-) diff --git a/docs/docs/acknowledgements.md b/docs/docs/acknowledgements.md index 6807d90fd..46418fc79 100644 --- a/docs/docs/acknowledgements.md +++ b/docs/docs/acknowledgements.md @@ -22,7 +22,7 @@ keywords: - + diff --git a/docs/docs/guides/advanced-settings/advanced-settings.mdx b/docs/docs/guides/advanced-settings/advanced-settings.mdx index 7099843ca..f59d2b4ce 100644 --- a/docs/docs/guides/advanced-settings/advanced-settings.mdx +++ b/docs/docs/guides/advanced-settings/advanced-settings.mdx @@ -21,12 +21,12 @@ keywords: - - + + - + import Tabs from '@theme/Tabs'; diff --git a/docs/docs/guides/advanced-settings/http-proxy.mdx b/docs/docs/guides/advanced-settings/http-proxy.mdx index c3e3b0b52..b2b8c9e24 100644 --- a/docs/docs/guides/advanced-settings/http-proxy.mdx +++ b/docs/docs/guides/advanced-settings/http-proxy.mdx @@ -22,12 +22,12 @@ keywords: - - + + - + ## Why HTTPS Proxy? diff --git a/docs/docs/guides/best-practices.mdx b/docs/docs/guides/best-practices.mdx index 9f06ac68a..a170e07de 100644 --- a/docs/docs/guides/best-practices.mdx +++ b/docs/docs/guides/best-practices.mdx @@ -23,7 +23,7 @@ keywords: - + diff --git a/docs/docs/guides/common-error/broken-build.mdx b/docs/docs/guides/common-error/broken-build.mdx index 39004068b..ffa470e22 100644 --- a/docs/docs/guides/common-error/broken-build.mdx +++ b/docs/docs/guides/common-error/broken-build.mdx @@ -23,12 +23,12 @@ keywords: - - + + - + import Tabs from '@theme/Tabs'; diff --git a/docs/docs/guides/common-error/not-using-gpu.mdx b/docs/docs/guides/common-error/not-using-gpu.mdx index d0f719919..acc359093 100644 --- a/docs/docs/guides/common-error/not-using-gpu.mdx +++ b/docs/docs/guides/common-error/not-using-gpu.mdx @@ -23,12 +23,12 @@ keywords: [ - - + + - + import Tabs from '@theme/Tabs'; diff --git a/docs/docs/guides/error-codes/how-to-get-error-logs.mdx b/docs/docs/guides/error-codes/how-to-get-error-logs.mdx index 03c6ec87c..aeec5b183 100644 --- a/docs/docs/guides/error-codes/how-to-get-error-logs.mdx +++ b/docs/docs/guides/error-codes/how-to-get-error-logs.mdx @@ -23,12 +23,12 @@ keywords: - - + + - + To get the error logs of your Jan application, follow the steps below: diff --git a/docs/docs/guides/error-codes/no-assistant-available.mdx b/docs/docs/guides/error-codes/no-assistant-available.mdx index 2d298aca0..01f2cf6a2 100644 --- a/docs/docs/guides/error-codes/no-assistant-available.mdx +++ b/docs/docs/guides/error-codes/no-assistant-available.mdx @@ -23,12 +23,12 @@ keywords: - - + + - + When you encounter the following error message: diff --git a/docs/docs/guides/error-codes/something-amiss.mdx b/docs/docs/guides/error-codes/something-amiss.mdx index 8ecaeacf3..51b8c0cf4 100644 --- a/docs/docs/guides/error-codes/something-amiss.mdx +++ b/docs/docs/guides/error-codes/something-amiss.mdx @@ -10,7 +10,7 @@ description: A step-by-step guide to resolve an unspecified or general error. - + diff --git a/docs/docs/guides/error-codes/stuck-on-loading-model.mdx b/docs/docs/guides/error-codes/stuck-on-loading-model.mdx index 80f55d403..a44e93919 100644 --- a/docs/docs/guides/error-codes/stuck-on-loading-model.mdx +++ b/docs/docs/guides/error-codes/stuck-on-loading-model.mdx @@ -23,7 +23,7 @@ keywords: - + diff --git a/docs/docs/guides/error-codes/thread-disappreance.mdx b/docs/docs/guides/error-codes/thread-disappreance.mdx index ef8c35f64..edae02ac0 100644 --- a/docs/docs/guides/error-codes/thread-disappreance.mdx +++ b/docs/docs/guides/error-codes/thread-disappreance.mdx @@ -23,7 +23,7 @@ keywords: - + diff --git a/docs/docs/guides/error-codes/undefined-issue.mdx b/docs/docs/guides/error-codes/undefined-issue.mdx index 5f4281155..cf0814977 100644 --- a/docs/docs/guides/error-codes/undefined-issue.mdx +++ b/docs/docs/guides/error-codes/undefined-issue.mdx @@ -23,7 +23,7 @@ keywords: - + diff --git a/docs/docs/guides/error-codes/unexpected-token.mdx b/docs/docs/guides/error-codes/unexpected-token.mdx index 28f69af51..f62da648b 100644 --- a/docs/docs/guides/error-codes/unexpected-token.mdx +++ b/docs/docs/guides/error-codes/unexpected-token.mdx @@ -23,7 +23,7 @@ keywords: - + diff --git a/docs/docs/guides/faq.mdx b/docs/docs/guides/faq.mdx index f1d1fca2c..21cf1a232 100644 --- a/docs/docs/guides/faq.mdx +++ b/docs/docs/guides/faq.mdx @@ -23,7 +23,7 @@ keywords: - + diff --git a/docs/docs/guides/install.mdx b/docs/docs/guides/install.mdx index b64469411..e4e863c1d 100644 --- a/docs/docs/guides/install.mdx +++ b/docs/docs/guides/install.mdx @@ -22,7 +22,7 @@ keywords: - + diff --git a/docs/docs/guides/integration/azure.mdx b/docs/docs/guides/integration/azure.mdx index 71f070ffb..fa22549de 100644 --- a/docs/docs/guides/integration/azure.mdx +++ b/docs/docs/guides/integration/azure.mdx @@ -23,7 +23,7 @@ keywords: - + diff --git a/docs/docs/guides/integration/discord.mdx b/docs/docs/guides/integration/discord.mdx index 9bff868d9..79ada5396 100644 --- a/docs/docs/guides/integration/discord.mdx +++ b/docs/docs/guides/integration/discord.mdx @@ -10,7 +10,7 @@ description: A step-by-step guide on how to integrate Jan with a Discord bot. - + diff --git a/docs/docs/guides/integration/groq.mdx b/docs/docs/guides/integration/groq.mdx index db97461a7..b1af58c9f 100644 --- a/docs/docs/guides/integration/groq.mdx +++ b/docs/docs/guides/integration/groq.mdx @@ -23,7 +23,7 @@ keywords: - + diff --git a/docs/docs/guides/integration/lmstudio.mdx b/docs/docs/guides/integration/lmstudio.mdx index 058c2df49..6fdf36cee 100644 --- a/docs/docs/guides/integration/lmstudio.mdx +++ b/docs/docs/guides/integration/lmstudio.mdx @@ -22,7 +22,7 @@ keywords: - + diff --git a/docs/docs/guides/integration/mistral.mdx b/docs/docs/guides/integration/mistral.mdx index 200713422..129bdee21 100644 --- a/docs/docs/guides/integration/mistral.mdx +++ b/docs/docs/guides/integration/mistral.mdx @@ -22,7 +22,7 @@ keywords: - + diff --git a/docs/docs/guides/integration/ollama.mdx b/docs/docs/guides/integration/ollama.mdx index bbf6cc826..c3ee4cd0f 100644 --- a/docs/docs/guides/integration/ollama.mdx +++ b/docs/docs/guides/integration/ollama.mdx @@ -22,7 +22,7 @@ keywords: - + diff --git a/docs/docs/guides/integration/openinterpreter.mdx b/docs/docs/guides/integration/openinterpreter.mdx index a637736dc..ba77738e3 100644 --- a/docs/docs/guides/integration/openinterpreter.mdx +++ b/docs/docs/guides/integration/openinterpreter.mdx @@ -10,7 +10,7 @@ description: A step-by-step guide on how to integrate Jan with Open Interpreter. - + diff --git a/docs/docs/guides/integration/openrouter.mdx b/docs/docs/guides/integration/openrouter.mdx index 01f8077ba..e095a42f1 100644 --- a/docs/docs/guides/integration/openrouter.mdx +++ b/docs/docs/guides/integration/openrouter.mdx @@ -10,7 +10,7 @@ description: A step-by-step guide on how to integrate Jan with OpenRouter. - + diff --git a/docs/docs/guides/integration/raycast.mdx b/docs/docs/guides/integration/raycast.mdx index 4e255872b..4da6e849b 100644 --- a/docs/docs/guides/integration/raycast.mdx +++ b/docs/docs/guides/integration/raycast.mdx @@ -10,7 +10,7 @@ description: A step-by-step guide on how to integrate Jan with Raycast. - + diff --git a/docs/docs/guides/integration/vscode.mdx b/docs/docs/guides/integration/vscode.mdx index 75c477e15..05b141180 100644 --- a/docs/docs/guides/integration/vscode.mdx +++ b/docs/docs/guides/integration/vscode.mdx @@ -23,7 +23,7 @@ keywords: - + diff --git a/docs/docs/guides/models-list.mdx b/docs/docs/guides/models-list.mdx index 48f6c7ba5..7d80c0220 100644 --- a/docs/docs/guides/models-list.mdx +++ b/docs/docs/guides/models-list.mdx @@ -9,7 +9,7 @@ sidebar_position: 3 - + diff --git a/docs/docs/guides/models/customize-engine.mdx b/docs/docs/guides/models/customize-engine.mdx index 9f3eb5eb9..91d9615f3 100644 --- a/docs/docs/guides/models/customize-engine.mdx +++ b/docs/docs/guides/models/customize-engine.mdx @@ -23,7 +23,7 @@ keywords: - + diff --git a/docs/docs/guides/models/import-models.mdx b/docs/docs/guides/models/import-models.mdx index 5f1a75ab5..1c131503f 100644 --- a/docs/docs/guides/models/import-models.mdx +++ b/docs/docs/guides/models/import-models.mdx @@ -23,7 +23,7 @@ keywords: - + diff --git a/docs/docs/guides/models/integrate-remote.mdx b/docs/docs/guides/models/integrate-remote.mdx index 46e2bf508..1a0435926 100644 --- a/docs/docs/guides/models/integrate-remote.mdx +++ b/docs/docs/guides/models/integrate-remote.mdx @@ -24,7 +24,7 @@ keywords: - + diff --git a/docs/docs/guides/providers/llama-cpp.md b/docs/docs/guides/providers/llama-cpp.md index 0116973bd..6e1e294b0 100644 --- a/docs/docs/guides/providers/llama-cpp.md +++ b/docs/docs/guides/providers/llama-cpp.md @@ -9,7 +9,7 @@ slug: /guides/providers/llama-cpp - + diff --git a/docs/docs/guides/providers/tensorrt-llm.md b/docs/docs/guides/providers/tensorrt-llm.md index ad37c1969..b0485fd57 100644 --- a/docs/docs/guides/providers/tensorrt-llm.md +++ b/docs/docs/guides/providers/tensorrt-llm.md @@ -9,7 +9,7 @@ slug: /guides/providers/tensorrt-llm - + diff --git a/docs/docs/guides/quickstart.mdx b/docs/docs/guides/quickstart.mdx index e0702b0eb..5fea2f978 100644 --- a/docs/docs/guides/quickstart.mdx +++ b/docs/docs/guides/quickstart.mdx @@ -22,7 +22,7 @@ keywords: - + diff --git a/docs/docs/guides/start-server.mdx b/docs/docs/guides/start-server.mdx index 741eb2ffc..8d394c9d4 100644 --- a/docs/docs/guides/start-server.mdx +++ b/docs/docs/guides/start-server.mdx @@ -10,7 +10,7 @@ description: A step-by-step guide to start Jan Local Server. - + diff --git a/docs/docs/guides/thread.mdx b/docs/docs/guides/thread.mdx index cb6940a89..4852aa0c2 100644 --- a/docs/docs/guides/thread.mdx +++ b/docs/docs/guides/thread.mdx @@ -11,7 +11,7 @@ description: Manage your interaction with AI locally. - + diff --git a/docs/docs/hardware/overview/cloud-vs-self-hosting.md b/docs/docs/hardware/overview/cloud-vs-self-hosting.md index 8452d6967..f4d4b2236 100644 --- a/docs/docs/hardware/overview/cloud-vs-self-hosting.md +++ b/docs/docs/hardware/overview/cloud-vs-self-hosting.md @@ -8,7 +8,7 @@ title: Cloud vs. Self-hosting Your AI - + diff --git a/docs/docs/hardware/overview/cpu-vs-gpu.md b/docs/docs/hardware/overview/cpu-vs-gpu.md index 7ebd327b4..b50655574 100644 --- a/docs/docs/hardware/overview/cpu-vs-gpu.md +++ b/docs/docs/hardware/overview/cpu-vs-gpu.md @@ -9,7 +9,7 @@ title: GPU vs CPU What's the Difference? - + diff --git a/docs/docs/how-we-work.md b/docs/docs/how-we-work.md index b8b24bdb2..602f7c902 100644 --- a/docs/docs/how-we-work.md +++ b/docs/docs/how-we-work.md @@ -8,7 +8,7 @@ title: How We Work - + diff --git a/docs/docs/how-we-work/analytics/analytics.md b/docs/docs/how-we-work/analytics/analytics.md index e938a9734..5991263cc 100644 --- a/docs/docs/how-we-work/analytics/analytics.md +++ b/docs/docs/how-we-work/analytics/analytics.md @@ -8,7 +8,7 @@ title: Analytics - + diff --git a/docs/docs/how-we-work/engineering/qa.mdx b/docs/docs/how-we-work/engineering/qa.mdx index 8e10ef0b1..aa851dfa3 100644 --- a/docs/docs/how-we-work/engineering/qa.mdx +++ b/docs/docs/how-we-work/engineering/qa.mdx @@ -21,7 +21,7 @@ keywords: - + diff --git a/docs/docs/how-we-work/project-management/project-management.md b/docs/docs/how-we-work/project-management/project-management.md index f35a6ba77..85bbe0d75 100644 --- a/docs/docs/how-we-work/project-management/project-management.md +++ b/docs/docs/how-we-work/project-management/project-management.md @@ -8,7 +8,7 @@ title: Project Management - + diff --git a/docs/docs/how-we-work/strategy/strategy.md b/docs/docs/how-we-work/strategy/strategy.md index 26c1ca74b..a448c090e 100644 --- a/docs/docs/how-we-work/strategy/strategy.md +++ b/docs/docs/how-we-work/strategy/strategy.md @@ -8,7 +8,7 @@ title: Strategy - + diff --git a/docs/docs/how-we-work/website-docs/website-docs.md b/docs/docs/how-we-work/website-docs/website-docs.md index 9288fa735..9dcedb0b8 100644 --- a/docs/docs/how-we-work/website-docs/website-docs.md +++ b/docs/docs/how-we-work/website-docs/website-docs.md @@ -8,7 +8,7 @@ title: Website & Docs - + diff --git a/docs/docs/platforms/desktop.md b/docs/docs/platforms/desktop.md index f09013b6b..d8c8a38cc 100644 --- a/docs/docs/platforms/desktop.md +++ b/docs/docs/platforms/desktop.md @@ -21,7 +21,7 @@ keywords: - + diff --git a/docs/docs/server-suite/enterprise.md b/docs/docs/server-suite/enterprise.md index 187e97121..e08356954 100644 --- a/docs/docs/server-suite/enterprise.md +++ b/docs/docs/server-suite/enterprise.md @@ -21,7 +21,7 @@ keywords: - + diff --git a/docs/docs/server-suite/home-server.md b/docs/docs/server-suite/home-server.md index 9317f2f76..630d2b9d9 100644 --- a/docs/docs/server-suite/home-server.md +++ b/docs/docs/server-suite/home-server.md @@ -21,7 +21,7 @@ keywords: - + diff --git a/docs/docs/team/team.md b/docs/docs/team/team.md index 3af811933..2b8b24d01 100644 --- a/docs/docs/team/team.md +++ b/docs/docs/team/team.md @@ -8,7 +8,7 @@ title: Who we are - + diff --git a/docs/docs/wall-of-love.md b/docs/docs/wall-of-love.md index 359494162..41f68b0f2 100644 --- a/docs/docs/wall-of-love.md +++ b/docs/docs/wall-of-love.md @@ -8,7 +8,7 @@ title: Wall of Love ❤️ - +