diff --git a/docs/enterprise/index.mdx b/docs/enterprise/index.mdx index cf1819d0..9fc0b962 100644 --- a/docs/enterprise/index.mdx +++ b/docs/enterprise/index.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 2000 +sidebar_position: 400 title: "🏢 Open WebUI for Enterprises" --- diff --git a/docs/faq.mdx b/docs/faq.mdx index e36132ba..41191d86 100644 --- a/docs/faq.mdx +++ b/docs/faq.mdx @@ -98,7 +98,7 @@ To do this, configure your **Ollama model params** to allow a larger context win ### **Q: Is MCP (Model Context Protocol) supported in Open WebUI?** -**A:** [Yes, Open WebUI officially supports MCP Tool Servers—but exclusively through an **OpenAPI-compliant proxy**](/openapi-servers/mcp) ([openapi-servers](https://github.com/open-webui/openapi-servers)) for optimal compatibility, security, and maintainability. +**A:** [Yes, Open WebUI officially supports MCP Tool Servers—but exclusively through an **OpenAPI-compliant proxy**](/features/plugin/tools/openapi-servers/mcp) ([openapi-servers](https://github.com/open-webui/openapi-servers)) for optimal compatibility, security, and maintainability. To bridge MCP (and other backend protocols), we provide a purpose-built proxy implementation available at: 👉 [https://github.com/open-webui/mcpo](https://github.com/open-webui/mcpo) diff --git a/docs/features/index.mdx b/docs/features/index.mdx index 89af2b12..7431140f 100644 --- a/docs/features/index.mdx +++ b/docs/features/index.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 400 +sidebar_position: 200 title: "⭐ Features" --- diff --git a/docs/features/pipelines/tutorials.md b/docs/features/pipelines/tutorials.md index 1245d2df..bbaed36d 100644 --- a/docs/features/pipelines/tutorials.md +++ b/docs/features/pipelines/tutorials.md @@ -1,6 +1,6 @@ --- sidebar_position: 7 -title: "Pipeline Tutorials" +title: "Tutorials" --- ## Pipeline Tutorials diff --git a/docs/features/pipelines/valves.md b/docs/features/pipelines/valves.md index f11332fc..f99aee73 100644 --- a/docs/features/pipelines/valves.md +++ b/docs/features/pipelines/valves.md @@ -5,7 +5,7 @@ title: "Valves" ## Valves -`Valves` (see the dedicated [Valves & UserValves](/features/plugin/valves) page) can also be set for `Pipeline`. In short, `Valves` are input variables that are set per pipeline. +`Valves` (see the dedicated [Valves & UserValves](/features/plugin/development/valves) page) can also be set for `Pipeline`. In short, `Valves` are input variables that are set per pipeline. `Valves` are set as a subclass of the `Pipeline` class, and initialized as part of the `__init__` method of the `Pipeline` class. diff --git a/docs/features/plugin/development/_category_.json b/docs/features/plugin/development/_category_.json new file mode 100644 index 00000000..404bd0f2 --- /dev/null +++ b/docs/features/plugin/development/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Development", + "position": 800, + "link": { + "type": "generated-index" + } +} diff --git a/docs/features/plugin/events/index.mdx b/docs/features/plugin/development/events.mdx similarity index 99% rename from docs/features/plugin/events/index.mdx rename to docs/features/plugin/development/events.mdx index 9f2777f3..09f66ab1 100644 --- a/docs/features/plugin/events/index.mdx +++ b/docs/features/plugin/development/events.mdx @@ -92,7 +92,7 @@ Below is a comprehensive table of **all supported `type` values** for events, al | `chat:message:files`,
`files` | Set or overwrite message files (for uploads, output) | `{files: [...]}` | | `chat:title` | Set (or update) the chat conversation title | Topic string OR `{title: ...}` | | `chat:tags` | Update the set of tags for a chat | Tag array or object | -| `source`,
`citation` | Add a source/citation, or code execution result | For code: See [below.](/docs/features/plugin/events/index.mdx#source-or-citation-and-code-execution) | +| `source`,
`citation` | Add a source/citation, or code execution result | For code: See [below.](/features/plugin/development/events#source-or-citation-and-code-execution) | | `notification` | Show a notification ("toast") in the UI | `{type: "info" or "success" or "error" or "warning", content: "..."}` | | `confirmation`
(needs `__event_call__`) | Ask for confirmation (OK/Cancel dialog) | `{title: "...", message: "..."}` | | `input`
(needs `__event_call__`) | Request simple user input ("input box" dialog) | `{title: "...", message: "...", placeholder: "...", value: ...}` | diff --git a/docs/features/plugin/reserved-args.mdx b/docs/features/plugin/development/reserved-args.mdx similarity index 99% rename from docs/features/plugin/reserved-args.mdx rename to docs/features/plugin/development/reserved-args.mdx index 91ecb711..1f389e7f 100644 --- a/docs/features/plugin/reserved-args.mdx +++ b/docs/features/plugin/development/reserved-args.mdx @@ -1,6 +1,6 @@ --- -sidebar_position: 20 -title: "Special Arguments" +sidebar_position: 999 +title: "Reserved Arguments" --- :::warning diff --git a/docs/features/plugin/valves/index.mdx b/docs/features/plugin/development/valves.mdx similarity index 100% rename from docs/features/plugin/valves/index.mdx rename to docs/features/plugin/development/valves.mdx diff --git a/docs/features/plugin/migration/index.mdx b/docs/features/plugin/migration/index.mdx index 58e457bc..8602a54f 100644 --- a/docs/features/plugin/migration/index.mdx +++ b/docs/features/plugin/migration/index.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 9999 title: "Migrating Tools & Functions: 0.4 to 0.5" --- diff --git a/docs/features/plugin/tools/development.mdx b/docs/features/plugin/tools/development.mdx index 2e9985f7..5bfe2a2a 100644 --- a/docs/features/plugin/tools/development.mdx +++ b/docs/features/plugin/tools/development.mdx @@ -52,7 +52,7 @@ Each tool must have type hints for arguments. The types may also be nested, such ### Valves and UserValves - (optional, but HIGHLY encouraged) -Valves and UserValves are used for specifying customizable settings of the Tool, you can read more on the dedicated [Valves & UserValves page](/features/plugin/valves/index.mdx). +Valves and UserValves are used for specifying customizable settings of the Tool, you can read more on the dedicated [Valves & UserValves page](/features/plugin/development/valves). ### Optional Arguments Below is a list of optional arguments your tools can depend on: diff --git a/docs/openapi-servers/faq.mdx b/docs/features/plugin/tools/openapi-servers/faq.mdx similarity index 100% rename from docs/openapi-servers/faq.mdx rename to docs/features/plugin/tools/openapi-servers/faq.mdx diff --git a/docs/openapi-servers/index.mdx b/docs/features/plugin/tools/openapi-servers/index.mdx similarity index 98% rename from docs/openapi-servers/index.mdx rename to docs/features/plugin/tools/openapi-servers/index.mdx index 4841404a..fbe3aee8 100644 --- a/docs/openapi-servers/index.mdx +++ b/docs/features/plugin/tools/openapi-servers/index.mdx @@ -1,6 +1,6 @@ --- sidebar_position: 400 -title: "🔨 OpenAPI Tool Servers" +title: "OpenAPI Tool Servers" --- import { TopBanners } from "@site/src/components/TopBanners"; diff --git a/docs/openapi-servers/mcp.mdx b/docs/features/plugin/tools/openapi-servers/mcp.mdx similarity index 100% rename from docs/openapi-servers/mcp.mdx rename to docs/features/plugin/tools/openapi-servers/mcp.mdx diff --git a/docs/openapi-servers/open-webui.mdx b/docs/features/plugin/tools/openapi-servers/open-webui.mdx similarity index 100% rename from docs/openapi-servers/open-webui.mdx rename to docs/features/plugin/tools/openapi-servers/open-webui.mdx diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index a1e0e490..2b1c4b1a 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -1,5 +1,5 @@ --- -sidebar_position: 200 +sidebar_position: 100 title: "🚀 Getting Started" --- diff --git a/docs/troubleshooting/index.mdx b/docs/troubleshooting/index.mdx index f9b973f7..0e0f218d 100644 --- a/docs/troubleshooting/index.mdx +++ b/docs/troubleshooting/index.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 600 +sidebar_position: 300 title: "🛠️ Troubleshooting" --- import { TopBanners } from "@site/src/components/TopBanners";