diff --git a/docs/src/pages/docs/desktop/data-folder.mdx b/docs/src/pages/docs/desktop/data-folder.mdx index 9db2402f4..2e44df6f3 100644 --- a/docs/src/pages/docs/desktop/data-folder.mdx +++ b/docs/src/pages/docs/desktop/data-folder.mdx @@ -155,7 +155,7 @@ Debugging headquarters (`/logs/app.txt`): The silicon brain collection. Each model has its own `model.json`. -Full parameters: [here](/docs/desktop/desktop/model-parameters) +Full parameters: [here](/docs/desktop/model-parameters) ### `threads/` @@ -216,5 +216,5 @@ Chat archive. Each thread (`/threads/jan_unixstamp/`) contains: ## Delete Jan Data -Uninstall guides: [Mac](/docs/desktop/desktop/install/mac#step-2-clean-up-data-optional), -[Windows](/docs/desktop/desktop/install/windows#step-2-handle-jan-data), or [Linux](docs/desktop/install/linux#uninstall-jan). +Uninstall guides: [Mac](/docs/desktop/install/mac#step-2-clean-up-data-optional), +[Windows](/docs/desktop/install/windows#step-2-handle-jan-data), or [Linux](docs/desktop/install/linux#uninstall-jan). diff --git a/docs/src/pages/docs/desktop/index.mdx b/docs/src/pages/docs/desktop/index.mdx index c46ddfeda..a6ebed221 100644 --- a/docs/src/pages/docs/desktop/index.mdx +++ b/docs/src/pages/docs/desktop/index.mdx @@ -184,9 +184,9 @@ Jan is built on the shoulders of giants: **Supported OS**: - - [Windows 10+](/docs/desktop/desktop/install/windows#compatibility) - - [macOS 12+](/docs/desktop/desktop/install/mac#compatibility) - - [Linux (Ubuntu 20.04+)](/docs/desktop/desktop/install/linux) + - [Windows 10+](/docs/desktop/install/windows#compatibility) + - [macOS 12+](/docs/desktop/install/mac#compatibility) + - [Linux (Ubuntu 20.04+)](/docs/desktop/install/linux) **Hardware**: - Minimum: 8GB RAM, 10GB storage @@ -216,7 +216,7 @@ Jan is built on the shoulders of giants: - Runs 100% offline once models are downloaded - - All data stored locally in [Jan Data Folder](/docs/desktop/desktop/data-folder) + - All data stored locally in [Jan Data Folder](/docs/desktop/data-folder) - No telemetry without explicit consent - Open source code you can audit diff --git a/docs/src/pages/docs/desktop/llama-cpp-server.mdx b/docs/src/pages/docs/desktop/llama-cpp-server.mdx index 54efcdd20..0d72020db 100644 --- a/docs/src/pages/docs/desktop/llama-cpp-server.mdx +++ b/docs/src/pages/docs/desktop/llama-cpp-server.mdx @@ -24,7 +24,7 @@ import { Settings } from 'lucide-react' `llama.cpp` is the core **inference engine** Jan uses to run AI models locally on your computer. This section covers the settings for the engine itself, which control *how* a model processes information on your hardware. -Looking for API server settings (like port, host, CORS)? They have been moved to the dedicated [**Local API Server**](/docs/desktop/desktop/api-server) page. +Looking for API server settings (like port, host, CORS)? They have been moved to the dedicated [**Local API Server**](/docs/desktop/api-server) page. ## Accessing Engine Settings diff --git a/docs/src/pages/docs/desktop/manage-models.mdx b/docs/src/pages/docs/desktop/manage-models.mdx index 08781f47f..5014cf431 100644 --- a/docs/src/pages/docs/desktop/manage-models.mdx +++ b/docs/src/pages/docs/desktop/manage-models.mdx @@ -30,9 +30,9 @@ This guide shows you how to add, customize, and delete models within Jan. Local models are managed through [Llama.cpp](https://github.com/ggerganov/llama.cpp), and these models are in a format called GGUF. When you run them locally, they will use your computer's memory (RAM) and processing power, so please make sure that you download models that match the hardware specifications for your operating system: -- [Mac](/docs/desktop/desktop/install/mac#compatibility) -- [Windows](/docs/desktop/desktop/install/windows#compatibility) -- [Linux](/docs/desktop/desktop/install/linux#compatibility). +- [Mac](/docs/desktop/install/mac#compatibility) +- [Windows](/docs/desktop/install/windows#compatibility) +- [Linux](/docs/desktop/install/linux#compatibility). ### Adding Models @@ -156,7 +156,7 @@ For advanced users who want to add a specific model that is not available within Key fields to configure: 1. The **Settings** array is where you can set the path or location of your model in your computer, the context length allowed, and the chat template expected by your model. -2. The [**Parameters**](/docs/desktop/desktop/model-parameters) are the adjustable settings that affect how your model operates or +2. The [**Parameters**](/docs/desktop/model-parameters) are the adjustable settings that affect how your model operates or processes the data. The fields in the parameters array are typically general and can be used across different models. Here is an example of model parameters: @@ -186,7 +186,7 @@ models. Here is an example of model parameters: When using cloud models, be aware of any associated costs and rate limits from the providers. See detailed guide for -each cloud model provider [here](/docs/desktop/desktop/remote-models/anthropic). +each cloud model provider [here](/docs/desktop/remote-models/anthropic). Jan supports connecting to various AI cloud providers that are OpenAI API-compatible, including: OpenAI (GPT-4o, o3,...), diff --git a/docs/src/pages/docs/desktop/mcp.mdx b/docs/src/pages/docs/desktop/mcp.mdx index 0c3fcfa1f..3440ddaab 100644 --- a/docs/src/pages/docs/desktop/mcp.mdx +++ b/docs/src/pages/docs/desktop/mcp.mdx @@ -100,7 +100,7 @@ making your workflows more modular and adaptable over time. To use MCP effectively, ensure your AI model supports tool calling capabilities: - For cloud models (like Claude or GPT-4): Verify tool calling is enabled in your API settings - - For local models: Enable tool calling in the model parameters [click the edit button in Model Capabilities](/docs/desktop/desktop/model-parameters#model-capabilities-edit-button) + - For local models: Enable tool calling in the model parameters [click the edit button in Model Capabilities](/docs/desktop/model-parameters#model-capabilities-edit-button) - Check the model's documentation to confirm MCP compatibility diff --git a/docs/src/pages/docs/desktop/privacy.mdx b/docs/src/pages/docs/desktop/privacy.mdx index 5f9d0d3dd..429b052dd 100644 --- a/docs/src/pages/docs/desktop/privacy.mdx +++ b/docs/src/pages/docs/desktop/privacy.mdx @@ -26,7 +26,7 @@ import { Callout } from 'nextra/components' Jan is your AI. Period. Here's what we do with data. -Full privacy policy lives [here](/docs/desktop/desktop/privacy-policy), if you're into that sort of thing. +Full privacy policy lives [here](/docs/desktop/privacy-policy), if you're into that sort of thing. diff --git a/docs/src/pages/docs/desktop/quickstart.mdx b/docs/src/pages/docs/desktop/quickstart.mdx index 9999f1644..668354a39 100644 --- a/docs/src/pages/docs/desktop/quickstart.mdx +++ b/docs/src/pages/docs/desktop/quickstart.mdx @@ -27,7 +27,7 @@ Get up and running with Jan in minutes. This guide will help you install Jan, do ### Step 1: Install Jan 1. [Download Jan](/download) -2. Install the app ([Mac](/docs/desktop/desktop/install/mac), [Windows](/docs/desktop/desktop/install/windows), [Linux](/docs/desktop/desktop/install/linux)) +2. Install the app ([Mac](/docs/desktop/install/mac), [Windows](/docs/desktop/install/windows), [Linux](/docs/desktop/install/linux)) 3. Launch Jan ### Step 2: Download Jan v1 @@ -61,7 +61,7 @@ Try asking Jan v1 questions like: - "What are the pros and cons of electric vehicles?" -**Want to give Jan v1 access to current web information?** Check out our [Serper MCP tutorial](/docs/desktop/desktop/mcp-examples/search/serper) to enable real-time web search with 2,500 free searches! +**Want to give Jan v1 access to current web information?** Check out our [Serper MCP tutorial](/docs/desktop/mcp-examples/search/serper) to enable real-time web search with 2,500 free searches! @@ -138,4 +138,4 @@ Connect to OpenAI, Anthropic, Groq, Mistral, and others: ![Connect Remote APIs](./_assets/quick-start-03.png) -For detailed setup, see [Remote APIs](/docs/desktop/desktop/remote-models/openai). +For detailed setup, see [Remote APIs](/docs/desktop/remote-models/openai). diff --git a/docs/src/pages/docs/desktop/server-settings.mdx b/docs/src/pages/docs/desktop/server-settings.mdx index 8e0a7bde9..f7be5af26 100644 --- a/docs/src/pages/docs/desktop/server-settings.mdx +++ b/docs/src/pages/docs/desktop/server-settings.mdx @@ -69,7 +69,7 @@ Click the gear icon next to any model to adjust how it behaves: - **Presence Penalty**: Encourages the model to use varied vocabulary -For detailed explanations of these parameters, see our [Model Parameters Guide](/docs/desktop/desktop/model-parameters). +For detailed explanations of these parameters, see our [Model Parameters Guide](/docs/desktop/model-parameters). ## Hardware Monitoring @@ -117,7 +117,7 @@ Access privacy settings at **Settings** > **Privacy**: - Change this setting anytime -See exactly what we collect (with your permission) in our [Privacy Policy](/docs/desktop/desktop/privacy). +See exactly what we collect (with your permission) in our [Privacy Policy](/docs/desktop/privacy). ![Analytics](./_assets/settings-07.png) @@ -174,7 +174,7 @@ This includes configuration for: - CORS (Cross-Origin Resource Sharing) - Verbose Logging -[**Go to Local API Server Settings →**](/docs/desktop/desktop/api-server) +[**Go to Local API Server Settings →**](/docs/desktop/api-server) ## Emergency Options diff --git a/docs/src/pages/docs/desktop/server-troubleshooting.mdx b/docs/src/pages/docs/desktop/server-troubleshooting.mdx index 4f5c1e983..dd51aed99 100644 --- a/docs/src/pages/docs/desktop/server-troubleshooting.mdx +++ b/docs/src/pages/docs/desktop/server-troubleshooting.mdx @@ -226,7 +226,7 @@ When models won't respond or show these errors: - **RAM:** Use models under 80% of available memory - 8GB system: Use models under 6GB - 16GB system: Use models under 13GB -- **Hardware:** Verify your system meets [minimum requirements](/docs/desktop/desktop/troubleshooting#step-1-verify-hardware-and-system-requirements) +- **Hardware:** Verify your system meets [minimum requirements](/docs/desktop/troubleshooting#step-1-verify-hardware-and-system-requirements) **2. Adjust Model Settings** - Open model settings in the chat sidebar @@ -318,9 +318,9 @@ If these solutions don't work: - Include your logs and system info **3. Check Resources:** -- [System requirements](/docs/desktop/desktop/troubleshooting#step-1-verify-hardware-and-system-requirements) -- [Model compatibility guides](/docs/desktop/desktop/manage-models) -- [Hardware setup guides](/docs/desktop/desktop/) +- [System requirements](/docs/desktop/troubleshooting#step-1-verify-hardware-and-system-requirements) +- [Model compatibility guides](/docs/desktop/manage-models) +- [Hardware setup guides](/docs/desktop/) When sharing logs, remove personal information first. We only keep logs for 24 hours, so report issues promptly. diff --git a/docs/src/pages/docs/desktop/settings.mdx b/docs/src/pages/docs/desktop/settings.mdx index d910ec875..6bc750f43 100644 --- a/docs/src/pages/docs/desktop/settings.mdx +++ b/docs/src/pages/docs/desktop/settings.mdx @@ -68,7 +68,7 @@ Click the gear icon next to a model to configure advanced settings: - **Repeat Penalty**: Controls how strongly the model avoids repeating phrases (higher values reduce repetition) - **Presence Penalty**: Discourages reusing words that already appeared in the text (helps with variety) -_See [Model Parameters](/docs/desktop/desktop/model-parameters) for a more detailed explanation._ +_See [Model Parameters](/docs/desktop/model-parameters) for a more detailed explanation._ ## Hardware @@ -108,7 +108,7 @@ You can help improve Jan by sharing anonymous usage data: 2. You can change this setting at any time -Read more about that we collect with opt-in users at [Privacy](/docs/desktop/desktop/privacy). +Read more about that we collect with opt-in users at [Privacy](/docs/desktop/privacy).
diff --git a/docs/src/pages/docs/desktop/troubleshooting.mdx b/docs/src/pages/docs/desktop/troubleshooting.mdx index 420cd17b3..16bbdfa9a 100644 --- a/docs/src/pages/docs/desktop/troubleshooting.mdx +++ b/docs/src/pages/docs/desktop/troubleshooting.mdx @@ -329,18 +329,18 @@ When you start a chat with a model and encounter a **Failed to Fetch** or **Some **1. Check System & Hardware Requirements** - Hardware dependencies: Ensure your device meets all [hardware requirements](docs/desktop/troubleshooting#step-1-verify-hardware-and-system-requirements) -- OS: Ensure your operating system meets the minimum requirements ([Mac](/docs/desktop/desktop/install/mac#minimum-requirements), [Windows](/docs/desktop/desktop/install/windows#compatibility), [Linux](/docs/desktop/desktop/install/linux#compatibility)) +- OS: Ensure your operating system meets the minimum requirements ([Mac](/docs/desktop/install/mac#minimum-requirements), [Windows](/docs/desktop/install/windows#compatibility), [Linux](/docs/desktop/install/linux#compatibility)) - RAM: Choose models that use less than 80% of your available RAM - For 8GB systems: Use models under 6GB - For 16GB systems: Use models under 13GB **2. Check Model Parameters** -- In **Engine Settings** in right sidebar, check your `ngl` ([number of GPU layers](/docs/desktop/desktop/models/model-parameters#engine-parameters)) setting to see if it's too high +- In **Engine Settings** in right sidebar, check your `ngl` ([number of GPU layers](/docs/desktop/models/model-parameters#engine-parameters)) setting to see if it's too high - Start with a lower NGL value and increase gradually based on your GPU memory **3. Port Conflicts** -If you check your [app logs](/docs/desktop/desktop/troubleshooting#how-to-get-error-logs) & see "Bind address failed at 127.0.0.1:39291", check port availability: +If you check your [app logs](/docs/desktop/troubleshooting#how-to-get-error-logs) & see "Bind address failed at 127.0.0.1:39291", check port availability: ``` # Mac netstat -an | grep 39291 @@ -371,7 +371,7 @@ This will delete all chat history, models, and settings. **5. Try a clean installation** -- Uninstall Jan & clean Jan data folders ([Mac](/docs/desktop/desktop/install/mac#uninstall-jan), [Windows](/docs/desktop/desktop/install/windows#uninstall-jan), [Linux](/docs/desktop/desktop/install/linux#uninstall-jan)) +- Uninstall Jan & clean Jan data folders ([Mac](/docs/desktop/install/mac#uninstall-jan), [Windows](/docs/desktop/install/windows#uninstall-jan), [Linux](/docs/desktop/install/linux#uninstall-jan)) - Install the latest [stable release](/download) @@ -392,7 +392,7 @@ The "Unexpected token" error usually relates to OpenAI API authentication or reg ## Need Further Support? If you can't find what you need in our troubleshooting guide, feel free reach out to us for extra help: -- **Copy** your [app logs](/docs/desktop/desktop/troubleshooting#how-to-get-error-logs) +- **Copy** your [app logs](/docs/desktop/troubleshooting#how-to-get-error-logs) - Go to our [Discord](https://discord.com/invite/FTk2MvZwJH) & send it to **#🆘|jan-help** channel for further support.