From 9b457e6e0caea522e1505dc1635b8a4d3bacc4f1 Mon Sep 17 00:00:00 2001 From: Silentoplayz <50341825+Silentoplayz@users.noreply.github.com> Date: Wed, 18 Dec 2024 14:44:08 -0500 Subject: [PATCH] More adjustments; laying groundwork More adjustments; laying groundwork --- docs/features/PWA.md | 8 ++++++++ docs/features/chat-overview/artifacts.md | 7 +++++++ docs/features/chat-overview/favorite.md | 7 +++++++ docs/features/chat-overview/index.mdx | 4 ++++ docs/features/chatshare.md | 8 ++++++++ docs/features/memory.md | 4 +++- docs/features/mermaid.md | 8 ++++++++ .../{playground(beta) => playgroundbeta}/chat.md | 4 +++- .../{playground(beta) => playgroundbeta}/completions.md | 5 ++++- .../{playground(beta) => playgroundbeta}/index.mdx | 4 +++- docs/features/python.md | 8 ++++++++ docs/features/rag.md | 4 +++- docs/features/usergroups/assign-user.md | 2 +- docs/features/usergroups/providing-access.md | 2 +- docs/features/usergroups/usergroup-perms.md | 2 +- docs/features/videocall.md | 8 ++++++++ docs/features/voicecall.md | 9 +++++++++ docs/tutorials/{integrations => }/docker-install.md | 2 +- docs/tutorials/integrations/apache.md | 2 +- docs/tutorials/integrations/browser-search-engine.md | 2 +- docs/tutorials/integrations/continue-dev.md | 2 +- docs/tutorials/integrations/custom-ca.md | 2 +- docs/tutorials/integrations/https-nginx.md | 2 +- docs/tutorials/integrations/ipex_llm.md | 2 +- docs/tutorials/integrations/langfuse.md | 2 +- docs/tutorials/stateless/index.mdx | 4 ++++ docs/tutorials/text-to-speech/index.mdx | 4 ++++ .../openai-edge-tts-integration.md | 4 ++-- .../openedai-speech-integration.md | 4 ++-- 29 files changed, 106 insertions(+), 20 deletions(-) create mode 100644 docs/features/PWA.md create mode 100644 docs/features/chat-overview/artifacts.md create mode 100644 docs/features/chat-overview/favorite.md create mode 100644 docs/features/chat-overview/index.mdx create mode 100644 docs/features/chatshare.md create mode 100644 docs/features/mermaid.md rename docs/features/{playground(beta) => playgroundbeta}/chat.md (81%) rename docs/features/{playground(beta) => playgroundbeta}/completions.md (81%) rename docs/features/{playground(beta) => playgroundbeta}/index.mdx (86%) create mode 100644 docs/features/python.md create mode 100644 docs/features/videocall.md create mode 100644 docs/features/voicecall.md rename docs/tutorials/{integrations => }/docker-install.md (98%) create mode 100644 docs/tutorials/stateless/index.mdx create mode 100644 docs/tutorials/text-to-speech/index.mdx rename docs/tutorials/{integrations => text-to-speech}/openai-edge-tts-integration.md (99%) rename docs/tutorials/{integrations => text-to-speech}/openedai-speech-integration.md (99%) diff --git a/docs/features/PWA.md b/docs/features/PWA.md new file mode 100644 index 00000000..069401eb --- /dev/null +++ b/docs/features/PWA.md @@ -0,0 +1,8 @@ +--- +sidebar_position: 18 +title: "๐Ÿ“ฑ Progressive Web App" +--- + +๐Ÿ“ฑ Progressive Web App for Mobile: Enjoy a native progressive web application experience on your mobile device with offline access on localhost or a personal domain, and a smooth user interface. In order for our PWA to be installable on your device, it must be delivered in a secure context. This usually means that it must be served over HTTPS. + + To set up a PWA, you'll need some understanding of technologies like Linux, Docker, and reverse proxies such as Nginx, Caddy, or Traefik. Using these tools can help streamline the process of building and deploying a PWA tailored to your needs. While there's no "one-click install" option available, and your available option to securely deploy your Open WebUI instance over HTTPS requires user experience, using these resources can make it easier to create and deploy a PWA tailored to your needs. diff --git a/docs/features/chat-overview/artifacts.md b/docs/features/chat-overview/artifacts.md new file mode 100644 index 00000000..2e0a2a67 --- /dev/null +++ b/docs/features/chat-overview/artifacts.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 2 +title: "๐Ÿบ Artifacts" +--- + + +Test diff --git a/docs/features/chat-overview/favorite.md b/docs/features/chat-overview/favorite.md new file mode 100644 index 00000000..043cd9d3 --- /dev/null +++ b/docs/features/chat-overview/favorite.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +title: "โญ Favorite Response" +--- + + +Test diff --git a/docs/features/chat-overview/index.mdx b/docs/features/chat-overview/index.mdx new file mode 100644 index 00000000..2a692fef --- /dev/null +++ b/docs/features/chat-overview/index.mdx @@ -0,0 +1,4 @@ +--- +sidebar_position: 1 +title: "๐Ÿ˜ Chat Overview" +--- \ No newline at end of file diff --git a/docs/features/chatshare.md b/docs/features/chatshare.md new file mode 100644 index 00000000..7ef69aba --- /dev/null +++ b/docs/features/chatshare.md @@ -0,0 +1,8 @@ +--- +sidebar_position: 19 +title: "๐Ÿ—จ๏ธ Chat Sharing" +--- + + + +๐Ÿ—จ๏ธ Local Chat Sharing: Generate and share chat links between users in an efficient and seamless manner, thereby enhancing collaboration and communication. diff --git a/docs/features/memory.md b/docs/features/memory.md index fbd2b0b6..a25e3d31 100644 --- a/docs/features/memory.md +++ b/docs/features/memory.md @@ -1,4 +1,6 @@ --- sidebar_position: 15 title: "๐Ÿง  Memory (Experimental)" ---- \ No newline at end of file +--- + +๐Ÿง  Memory Feature: Manually add information you want your LLMs to remember via the Settings > Personalization > Memory menu. Memories can be added, edited, and deleted. diff --git a/docs/features/mermaid.md b/docs/features/mermaid.md new file mode 100644 index 00000000..d3f63bbe --- /dev/null +++ b/docs/features/mermaid.md @@ -0,0 +1,8 @@ +--- +sidebar_position: 17 +title: "๐ŸŒŠ MermaidJS Rendering" +--- + + + +Create visually appealing diagrams and flowcharts directly within Open WebUI using the Mermaid Diagramming and charting tool, which supports Mermaid syntax rendering. diff --git a/docs/features/playground(beta)/chat.md b/docs/features/playgroundbeta/chat.md similarity index 81% rename from docs/features/playground(beta)/chat.md rename to docs/features/playgroundbeta/chat.md index 538c42e4..06494cf2 100644 --- a/docs/features/playground(beta)/chat.md +++ b/docs/features/playgroundbeta/chat.md @@ -1,4 +1,6 @@ --- sidebar_position: 0 title: "๐Ÿ’ฌ Chat" ---- \ No newline at end of file +--- + +Test diff --git a/docs/features/playground(beta)/completions.md b/docs/features/playgroundbeta/completions.md similarity index 81% rename from docs/features/playground(beta)/completions.md rename to docs/features/playgroundbeta/completions.md index 35467669..b7c2bb27 100644 --- a/docs/features/playground(beta)/completions.md +++ b/docs/features/playgroundbeta/completions.md @@ -1,4 +1,7 @@ --- sidebar_position: 1 title: "โœ… Completions" ---- \ No newline at end of file +--- + + +Test diff --git a/docs/features/playground(beta)/index.mdx b/docs/features/playgroundbeta/index.mdx similarity index 86% rename from docs/features/playground(beta)/index.mdx rename to docs/features/playgroundbeta/index.mdx index 3f071ce3..fec1eab4 100644 --- a/docs/features/playground(beta)/index.mdx +++ b/docs/features/playgroundbeta/index.mdx @@ -5,4 +5,6 @@ title: "๐Ÿ› Playground (Beta)" import { TopBanners } from "@site/src/components/TopBanners"; - \ No newline at end of file + + +Test \ No newline at end of file diff --git a/docs/features/python.md b/docs/features/python.md new file mode 100644 index 00000000..328775b3 --- /dev/null +++ b/docs/features/python.md @@ -0,0 +1,8 @@ +--- +sidebar_position: 16 +title: "๐Ÿ Python Code Execution" +--- + + + +Python Code Execution: Execute Python code locally in the browser via Pyodide with a range of libraries supported by Pyodide. diff --git a/docs/features/rag.md b/docs/features/rag.md index 1fcfd455..4b5998e9 100644 --- a/docs/features/rag.md +++ b/docs/features/rag.md @@ -3,7 +3,7 @@ sidebar_position: 8 title: "๐Ÿ”Ž Retrieval Augmented Generation (RAG)" --- -Retrieval Augmented Generation (RAG) is a a cutting-edge technology that enhances the conversational capabilities of chatbots by incorporating context from diverse sources. It works by retrieving relevant information from a wide range of sources such as local and remote documents, web content, and even multimedia sources like YouTube videos. The retrieved text is then combined with a predefined RAG template and prefixed to the user's prompt, providing a more informed and contextually relevant response. +Retrieval Augmented Generation (RAG) is a cutting-edge technology that enhances the conversational capabilities of chatbots by incorporating context from diverse sources. It works by retrieving relevant information from a wide range of sources such as local and remote documents, web content, and even multimedia sources like YouTube videos. The retrieved text is then combined with a predefined RAG template and prefixed to the user's prompt, providing a more informed and contextually relevant response. One of the key advantages of RAG is its ability to access and integrate information from a variety of sources, making it an ideal solution for complex conversational scenarios. For instance, when a user asks a question related to a specific document or web page, RAG can retrieve and incorporate the relevant information from that source into the chat response. RAG can also retrieve and incorporate information from multimedia sources like YouTube videos. By analyzing the transcripts or captions of these videos, RAG can extract relevant information and incorporate it into the chat response. @@ -11,6 +11,8 @@ One of the key advantages of RAG is its ability to access and integrate informat Local documents must first be uploaded via the Documents section of the Workspace area to access them using the `#` symbol before a query. Click on the formatted URL in the that appears above the chat box. Once selected, a document icon appears above `Send a message`, indicating successful retrieval. +You can also load documents into the workspace area with their access by starting a prompt with `#`, followed by a URL. This can help incorporate web content directly into your conversations. + ## Web Search for RAG For web content integration, start a query in a chat with `#`, followed by the target URL. Click on the formatted URL in the box that appears above the chat box. Once selected, a document icon appears above `Send a message`, indicating successful retrieval. Open WebUI fetches and parses information from the URL if it can. diff --git a/docs/features/usergroups/assign-user.md b/docs/features/usergroups/assign-user.md index 9fe6fec7..036276e0 100644 --- a/docs/features/usergroups/assign-user.md +++ b/docs/features/usergroups/assign-user.md @@ -1,4 +1,4 @@ --- sidebar_position: 1 -title: "๐Ÿ‘จโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Assign Users to Usergroup" +title: "๐Ÿ‘ฅ Assign Users to Usergroup" --- \ No newline at end of file diff --git a/docs/features/usergroups/providing-access.md b/docs/features/usergroups/providing-access.md index 2d9fb9e7..a5b223d3 100644 --- a/docs/features/usergroups/providing-access.md +++ b/docs/features/usergroups/providing-access.md @@ -1,4 +1,4 @@ --- sidebar_position: 2 -title: "๐Ÿ‘จโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Provide User Group Access" +title: "โœ… Provide User Group Access" --- \ No newline at end of file diff --git a/docs/features/usergroups/usergroup-perms.md b/docs/features/usergroups/usergroup-perms.md index 23da389b..e4a83bee 100644 --- a/docs/features/usergroups/usergroup-perms.md +++ b/docs/features/usergroups/usergroup-perms.md @@ -1,4 +1,4 @@ --- sidebar_position: 0 -title: "๐Ÿ‘จโ€๐Ÿ‘งโ€๐Ÿ‘ฆ User Group Permissions" +title: "โ˜‘๏ธ User Group Permissions" --- \ No newline at end of file diff --git a/docs/features/videocall.md b/docs/features/videocall.md new file mode 100644 index 00000000..b47a33d0 --- /dev/null +++ b/docs/features/videocall.md @@ -0,0 +1,8 @@ +--- +sidebar_position: 21 +title: "๐Ÿ“น Video Call" +--- + +๐Ÿ“น Video Call Feature: Enable video calls with supported vision models like LlaVA and GPT-4o, adding a visual dimension to your communications. + + Both Camera & Microphone access is required using a secure connection over HTTPS for this feature to work. diff --git a/docs/features/voicecall.md b/docs/features/voicecall.md new file mode 100644 index 00000000..ce402959 --- /dev/null +++ b/docs/features/voicecall.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 20 +title: "๐ŸŽ™๏ธ Hands-Free Voice Call" +--- + + +๐ŸŽ™๏ธ Hands-Free Voice Call Feature: Initiate voice calls without needing to use your hands, making interactions more seamless. + + Microphone access is required using a secure connection over HTTPS for this feature to work. diff --git a/docs/tutorials/integrations/docker-install.md b/docs/tutorials/docker-install.md similarity index 98% rename from docs/tutorials/integrations/docker-install.md rename to docs/tutorials/docker-install.md index 1f3ac0a5..865d9f64 100644 --- a/docs/tutorials/integrations/docker-install.md +++ b/docs/tutorials/docker-install.md @@ -1,6 +1,6 @@ --- sidebar_position: 2 -title: Installing Docker +title: ๐Ÿณ Installing Docker --- :::warning diff --git a/docs/tutorials/integrations/apache.md b/docs/tutorials/integrations/apache.md index 7b8d6259..f7467253 100644 --- a/docs/tutorials/integrations/apache.md +++ b/docs/tutorials/integrations/apache.md @@ -1,6 +1,6 @@ --- sidebar_position: 7 -title: "Hosting UI and Models separately" +title: "๐Ÿ—„๏ธ Hosting UI and Models separately" --- :::warning diff --git a/docs/tutorials/integrations/browser-search-engine.md b/docs/tutorials/integrations/browser-search-engine.md index a443ca4d..ede010f3 100644 --- a/docs/tutorials/integrations/browser-search-engine.md +++ b/docs/tutorials/integrations/browser-search-engine.md @@ -1,6 +1,6 @@ --- sidebar_position: 16 -title: "Browser Search Engine" +title: "๐ŸŒ Browser Search Engine" --- :::warning diff --git a/docs/tutorials/integrations/continue-dev.md b/docs/tutorials/integrations/continue-dev.md index a6854611..f94b552f 100644 --- a/docs/tutorials/integrations/continue-dev.md +++ b/docs/tutorials/integrations/continue-dev.md @@ -1,6 +1,6 @@ --- sidebar_position: 13 -title: "Continue.dev VSCode Extension with Open WebUI" +title: "โš›๏ธ Continue.dev VSCode Extension with Open WebUI" --- :::warning diff --git a/docs/tutorials/integrations/custom-ca.md b/docs/tutorials/integrations/custom-ca.md index c8b1eec9..62eeac48 100644 --- a/docs/tutorials/integrations/custom-ca.md +++ b/docs/tutorials/integrations/custom-ca.md @@ -1,6 +1,6 @@ --- sidebar_position: 14 -title: Setting up with custom CA store +title: "๐Ÿ›ƒ Setting up with custom CA store" --- :::warning diff --git a/docs/tutorials/integrations/https-nginx.md b/docs/tutorials/integrations/https-nginx.md index 66831954..53f76139 100644 --- a/docs/tutorials/integrations/https-nginx.md +++ b/docs/tutorials/integrations/https-nginx.md @@ -1,5 +1,5 @@ --- -title: HTTPS using Nginx +title: "๐Ÿ”’ HTTPS using Nginx" --- :::warning diff --git a/docs/tutorials/integrations/ipex_llm.md b/docs/tutorials/integrations/ipex_llm.md index a9519f75..2ef1636b 100644 --- a/docs/tutorials/integrations/ipex_llm.md +++ b/docs/tutorials/integrations/ipex_llm.md @@ -1,6 +1,6 @@ --- sidebar_position: 11 -title: "Local LLM Setup with IPEX-LLM on Intel GPU" +title: "๐Ÿ–ฅ๏ธ Local LLM Setup with IPEX-LLM on Intel GPU" --- :::warning diff --git a/docs/tutorials/integrations/langfuse.md b/docs/tutorials/integrations/langfuse.md index dd1314d3..b1d7a825 100644 --- a/docs/tutorials/integrations/langfuse.md +++ b/docs/tutorials/integrations/langfuse.md @@ -1,6 +1,6 @@ --- sidebar_position: 20 -title: "Monitoring and debugging with Langfuse" +title: "๐Ÿ’ฅ Monitoring and debugging with Langfuse" --- # Langfuse Integration with OpenWebUI diff --git a/docs/tutorials/stateless/index.mdx b/docs/tutorials/stateless/index.mdx new file mode 100644 index 00000000..bbf01755 --- /dev/null +++ b/docs/tutorials/stateless/index.mdx @@ -0,0 +1,4 @@ +--- +sidebar_position: 6 +title: "โš–๏ธ Stateless Load Balancing" +--- \ No newline at end of file diff --git a/docs/tutorials/text-to-speech/index.mdx b/docs/tutorials/text-to-speech/index.mdx new file mode 100644 index 00000000..0cfb6652 --- /dev/null +++ b/docs/tutorials/text-to-speech/index.mdx @@ -0,0 +1,4 @@ +--- +sidebar_position: 0 +title: "๐Ÿ—จ๏ธ Text-to-Speech" +--- \ No newline at end of file diff --git a/docs/tutorials/integrations/openai-edge-tts-integration.md b/docs/tutorials/text-to-speech/openai-edge-tts-integration.md similarity index 99% rename from docs/tutorials/integrations/openai-edge-tts-integration.md rename to docs/tutorials/text-to-speech/openai-edge-tts-integration.md index 58568ffd..d8b53da1 100644 --- a/docs/tutorials/integrations/openai-edge-tts-integration.md +++ b/docs/tutorials/text-to-speech/openai-edge-tts-integration.md @@ -1,6 +1,6 @@ --- -sidebar_position: 18 -title: "Edge TTS" +sidebar_position: 1 +title: "๐Ÿ—จ๏ธ Openai-edge-tts using Docker" --- :::warning diff --git a/docs/tutorials/integrations/openedai-speech-integration.md b/docs/tutorials/text-to-speech/openedai-speech-integration.md similarity index 99% rename from docs/tutorials/integrations/openedai-speech-integration.md rename to docs/tutorials/text-to-speech/openedai-speech-integration.md index 43746113..d0e90d13 100644 --- a/docs/tutorials/integrations/openedai-speech-integration.md +++ b/docs/tutorials/text-to-speech/openedai-speech-integration.md @@ -1,6 +1,6 @@ --- -sidebar_position: 12 -title: "TTS - OpenedAI-Speech using Docker" +sidebar_position: 2 +title: "๐Ÿ—จ๏ธ Openedai-speech using Docker" --- :::warning