Skip to content

Commit bf07a47

Browse files
committed
formatting
1 parent af3da2b commit bf07a47

File tree

8 files changed

+31
-23
lines changed

8 files changed

+31
-23
lines changed

docs/source/configuration/common-issues.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ If models aren't appearing in the UI:
3232
For development, you can skip MongoDB entirely - Chat UI will use an embedded database.
3333

3434
For production, verify:
35+
3536
- `MONGODB_URL` is a valid connection string
3637
- Your IP is whitelisted (for MongoDB Atlas)
3738
- The database user has read/write permissions

docs/source/configuration/llm-router.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,17 @@ Create a JSON file defining your routes. Each route specifies:
2323

2424
```json
2525
[
26-
{
27-
"name": "coding",
28-
"description": "Programming, debugging, code review",
29-
"primary_model": "Qwen/Qwen3-Coder-480B-A35B-Instruct",
30-
"fallback_models": ["meta-llama/Llama-3.3-70B-Instruct"]
31-
},
32-
{
33-
"name": "casual_conversation",
34-
"description": "General chat, questions, explanations",
35-
"primary_model": "meta-llama/Llama-3.3-70B-Instruct"
36-
}
26+
{
27+
"name": "coding",
28+
"description": "Programming, debugging, code review",
29+
"primary_model": "Qwen/Qwen3-Coder-480B-A35B-Instruct",
30+
"fallback_models": ["meta-llama/Llama-3.3-70B-Instruct"]
31+
},
32+
{
33+
"name": "casual_conversation",
34+
"description": "General chat, questions, explanations",
35+
"primary_model": "meta-llama/Llama-3.3-70B-Instruct"
36+
}
3737
]
3838
```
3939

docs/source/configuration/mcp-tools.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ MCP_SERVERS=[
1818
```
1919

2020
Each server entry requires:
21+
2122
- `name` - Display name shown in the UI
2223
- `url` - MCP server endpoint URL
2324
- `headers` (optional) - Custom headers for authentication

docs/source/configuration/overview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ MODELS=`[
3838
```
3939

4040
Override properties:
41+
4142
- `id` - Model identifier (must match an ID from the `/models` endpoint)
4243
- `name` - Display name in the UI
4344
- `multimodal` - Enable image uploads

docs/source/developing/architecture.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This document provides a high-level overview of the Chat UI codebase. If you're
77
Chat UI provides a simple interface connecting LLMs to external tools via MCP. The project uses [MongoDB](https://www.mongodb.com/) and [SvelteKit](https://kit.svelte.dev/) with [Tailwind](https://tailwindcss.com/).
88

99
Key architectural decisions:
10+
1011
- **OpenAI-compatible only**: All model interactions use the OpenAI API format
1112
- **MCP for tools**: Tool calling is handled via Model Context Protocol servers
1213
- **Auto-discovery**: Models are discovered from the `/models` endpoint

docs/source/index.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
Open source chat interface with support for tools, multimodal inputs, and intelligent routing across models. The app uses MongoDB and SvelteKit behind the scenes. Try the live version called [HuggingChat on hf.co/chat](https://huggingface.co/chat) or [setup your own instance](./installation/local).
44

55
Chat UI connects to any OpenAI-compatible API endpoint, making it work with:
6+
67
- [Hugging Face Inference Providers](https://huggingface.co/docs/inference-providers)
78
- [Ollama](https://ollama.ai)
89
- [llama.cpp](https://github.com/ggerganov/llama.cpp)
@@ -28,12 +29,12 @@ OPENAI_API_KEY=hf_************************
2829

2930
You can use any OpenAI-compatible endpoint:
3031

31-
| Provider | `OPENAI_BASE_URL` | `OPENAI_API_KEY` |
32-
|----------|-------------------|------------------|
33-
| Hugging Face | `https://router.huggingface.co/v1` | `hf_xxx` |
34-
| Ollama | `http://127.0.0.1:11434/v1` | `ollama` |
35-
| llama.cpp | `http://127.0.0.1:8080/v1` | `sk-local` |
36-
| OpenRouter | `https://openrouter.ai/api/v1` | `sk-or-v1-xxx` |
32+
| Provider | `OPENAI_BASE_URL` | `OPENAI_API_KEY` |
33+
| ------------ | ---------------------------------- | ---------------- |
34+
| Hugging Face | `https://router.huggingface.co/v1` | `hf_xxx` |
35+
| Ollama | `http://127.0.0.1:11434/v1` | `ollama` |
36+
| llama.cpp | `http://127.0.0.1:8080/v1` | `sk-local` |
37+
| OpenRouter | `https://openrouter.ai/api/v1` | `sk-or-v1-xxx` |
3738

3839
**Step 2 - Install and run:**
3940

docs/source/installation/local.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ That's it! Chat UI will discover available models automatically from your endpoi
2222

2323
Chat UI connects to any OpenAI-compatible API. Set `OPENAI_BASE_URL` to your provider:
2424

25-
| Provider | `OPENAI_BASE_URL` |
26-
|----------|-------------------|
25+
| Provider | `OPENAI_BASE_URL` |
26+
| ------------ | ---------------------------------- |
2727
| Hugging Face | `https://router.huggingface.co/v1` |
28-
| Ollama | `http://127.0.0.1:11434/v1` |
29-
| llama.cpp | `http://127.0.0.1:8080/v1` |
30-
| OpenRouter | `https://openrouter.ai/api/v1` |
28+
| Ollama | `http://127.0.0.1:11434/v1` |
29+
| llama.cpp | `http://127.0.0.1:8080/v1` |
30+
| OpenRouter | `https://openrouter.ai/api/v1` |
3131

3232
See the [configuration overview](../configuration/overview) for all available options.
3333

src/app.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
<html lang="en" class="h-full">
33
<head>
44
<meta charset="utf-8" />
5-
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no" />
5+
<meta
6+
name="viewport"
7+
content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"
8+
/>
69
<meta name="theme-color" content="rgb(249, 250, 251)" />
710
<script>
811
(function () {

0 commit comments

Comments
 (0)