From e2426c74e1e1efc2b097d9f799d94271b11475c6 Mon Sep 17 00:00:00 2001 From: fujie Date: Mon, 9 Mar 2026 21:48:33 +0800 Subject: [PATCH] docs: reorganize plugin and prompt installation instructions - Move 'Using Plugins' section before 'Using Prompts' in all quick start guides - Update plugin installation options with batch installation script - Move Prompts section after Plugins in project contents (already correct structure) - Update docs for English and Chinese versions (README.md, README_CN.md, docs/index.md, docs/index.zh.md) - Simplify installation flow: Community > Quick Install All > Prompts --- README.md | 14 +++++++------- README_CN.md | 7 +++++++ docs/index.md | 20 ++++++++------------ docs/index.zh.md | 20 ++++++++------------ 4 files changed, 30 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 27dd4ed..f33561a 100644 --- a/README.md +++ b/README.md @@ -163,13 +163,6 @@ For code examples, please check the `docs/examples/` directory. This project is a collection of resources and does not require a Python environment. Simply download the files you need and import them into your OpenWebUI instance. -### Using Prompts - -1. Browse the `/prompts` directory and select a prompt file (`.md`). -2. Copy the file content. -3. In the OpenWebUI chat interface, click the "Prompt" button above the input box. -4. Paste the content and save. - ### Using Plugins 1. **Install from OpenWebUI Community (Recommended)**: @@ -179,6 +172,13 @@ This project is a collection of resources and does not require a Python environm 2. **Quick Install All Plugins**: To install all plugins to your local OpenWebUI instance at once, clone this repo and run `python scripts/install_all_plugins.py` after configuring your API key in `.env` — see [Deployment Guide](./scripts/DEPLOYMENT_GUIDE.md) for details. +### Using Prompts + +1. Browse the `/prompts` directory and select a prompt file (`.md`). +2. Copy the file content. +3. In the OpenWebUI chat interface, click the "Prompt" button above the input box. +4. Paste the content and save. + ### Contributing If you have great prompts or plugins to share: diff --git a/README_CN.md b/README_CN.md index 6bcd355..6fb8f43 100644 --- a/README_CN.md +++ b/README_CN.md @@ -175,4 +175,11 @@ Open WebUI 的前端增强扩展： 2. **快速安装所有插件**：如果想一次性安装此项目中的所有插件到本地 OpenWebUI 实例，克隆此仓库后运行 `python scripts/install_all_plugins.py`，并在 `.env` 中配置好 API 密钥，详见 [部署指南](./scripts/DEPLOYMENT_GUIDE.md)。 +### 使用提示词 + +1. 浏览 `/prompts` 目录并选择一个提示词文件（`.md`）。 +2. 复制文件内容。 +3. 在 OpenWebUI 聊天界面中，点击输入框上方的"提示词"按钮。 +4. 粘贴内容并保存。 + [贡献指南](./CONTRIBUTING_CN.md) | [更新日志](./CHANGELOG.md) diff --git a/docs/index.md b/docs/index.md index aa5f939..0379515 100644 --- a/docs/index.md +++ b/docs/index.md @@ -103,13 +103,6 @@ hide: ## Quick Start -### Using Prompts - -1. Browse the [Prompt Library](prompts/library.md) and select a prompt -2. Click the **Copy** button to copy the prompt to your clipboard -3. In OpenWebUI, click the "Prompt" button above the input box -4. Paste the content and save - ### Using Plugins 1. **Install from OpenWebUI Community (Recommended)**: @@ -117,11 +110,14 @@ hide: - Browse the plugins and select the one you like. - Click "Get" to import it directly into your OpenWebUI instance. -2. **Manual Installation**: - - Browse the [Plugin Center](plugins/index.md) and download the plugin file (`.py`) - - Open OpenWebUI **Admin Panel** → **Settings** → **Plugins** - - Click the upload button and select the `.py` file - - Refresh the page and enable the plugin in your chat settings +2. **Quick Install All Plugins**: To install all plugins to your local OpenWebUI instance at once, clone this repo and run `python scripts/install_all_plugins.py` after configuring your API key in `.env` — see [Deployment Guide](../scripts/DEPLOYMENT_GUIDE.md) for details. + +### Using Prompts + +1. Browse the [Prompt Library](prompts/library.md) and select a prompt +2. Click the **Copy** button to copy the prompt to your clipboard +3. In OpenWebUI, click the "Prompt" button above the input box +4. Paste the content and save --- diff --git a/docs/index.zh.md b/docs/index.zh.md index 5e8be07..751b018 100644 --- a/docs/index.zh.md +++ b/docs/index.zh.md @@ -103,13 +103,6 @@ hide: ## 快速入门 -### 使用提示词 - -1. 浏览[提示词库](prompts/library.md)并选择一个提示词 -2. 点击**复制**按钮将提示词复制到剪贴板 -3. 在 OpenWebUI 中，点击输入框上方的"提示词"按钮 -4. 粘贴内容并保存 - ### 使用插件 1. **从 OpenWebUI 社区安装 (推荐)**: @@ -117,11 +110,14 @@ hide: - 浏览插件列表，选择你喜欢的插件。 - 点击 "Get" 按钮，将其直接导入到你的 OpenWebUI 实例中。 -2. **手动安装**: - - 浏览[插件中心](plugins/index.md)并下载插件文件（`.py`） - - 打开 OpenWebUI **管理面板** → **设置** → **插件** - - 点击上传按钮并选择 `.py` 文件 - - 刷新页面并在聊天设置中启用插件 +2. **快速安装全部插件**：想要一次性安装此项目中的所有插件到本地 OpenWebUI 实例，克隆此仓库后运行 `python scripts/install_all_plugins.py`，并在 `.env` 中配置好 API 密钥，详见[部署指南](../scripts/DEPLOYMENT_GUIDE.md)。 + +### 使用提示词 + +1. 浏览[提示词库](prompts/library.md)并选择一个提示词 +2. 点击**复制**按钮将提示词复制到剪贴板 +3. 在 OpenWebUI 中，点击输入框上方的"提示词"按钮 +4. 粘贴内容并保存 ---