From 321026229699fc1c558e24ebb439edc2814cb01b Mon Sep 17 00:00:00 2001 From: fujie Date: Mon, 9 Mar 2026 23:07:33 +0800 Subject: [PATCH] docs: update Deployment Guide links in multiple documents --- docs/index.md | 2 +- docs/index.zh.md | 2 +- docs/release-workflow.md | 6 +++++- docs/release-workflow.zh.md | 6 +++++- requirements.txt | 2 +- 5 files changed, 13 insertions(+), 5 deletions(-) diff --git a/docs/index.md b/docs/index.md index 0379515..7863749 100644 --- a/docs/index.md +++ b/docs/index.md @@ -110,7 +110,7 @@ hide: - Browse the plugins and select the one you like. - Click "Get" to import it directly into your OpenWebUI instance. -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. +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](https://github.com/Fu-Jie/openwebui-extensions/blob/main/scripts/DEPLOYMENT_GUIDE.md) for details. ### Using Prompts diff --git a/docs/index.zh.md b/docs/index.zh.md index 751b018..0f48d84 100644 --- a/docs/index.zh.md +++ b/docs/index.zh.md @@ -110,7 +110,7 @@ hide: - 浏览插件列表,选择你喜欢的插件。 - 点击 "Get" 按钮,将其直接导入到你的 OpenWebUI 实例中。 -2. **快速安装全部插件**:想要一次性安装此项目中的所有插件到本地 OpenWebUI 实例,克隆此仓库后运行 `python scripts/install_all_plugins.py`,并在 `.env` 中配置好 API 密钥,详见[部署指南](../scripts/DEPLOYMENT_GUIDE.md)。 +2. **快速安装全部插件**:想要一次性安装此项目中的所有插件到本地 OpenWebUI 实例,克隆此仓库后运行 `python scripts/install_all_plugins.py`,并在 `.env` 中配置好 API 密钥,详见[部署指南](https://github.com/Fu-Jie/openwebui-extensions/blob/main/scripts/DEPLOYMENT_GUIDE.md)。 ### 使用提示词 diff --git a/docs/release-workflow.md b/docs/release-workflow.md index 4c51a16..3cec432 100644 --- a/docs/release-workflow.md +++ b/docs/release-workflow.md @@ -128,11 +128,13 @@ We follow [Semantic Versioning](https://semver.org/): ### release.yml **Triggers:** + - ⭐ Push to `main` branch with `plugins/**/*.py` changes (auto-release) - Manual workflow dispatch - Push of version tags (`v*`) **Actions:** + 1. Detects version changes compared to last release 2. Collects updated plugin files 3. Generates release notes (with commit history) @@ -141,9 +143,11 @@ We follow [Semantic Versioning](https://semver.org/): ### plugin-version-check.yml **Trigger:** + - Pull requests that modify `plugins/**/*.py` **Actions:** + 1. Compares plugin versions between base and PR 2. Checks if version was updated 3. Checks if PR description is detailed enough @@ -208,7 +212,7 @@ echo "url=http://localhost:3000" >> scripts/.env python scripts/install_all_plugins.py ``` -For detailed instructions, see [Deployment Guide](./scripts/DEPLOYMENT_GUIDE.md). +For detailed instructions, see [Deployment Guide](https://github.com/Fu-Jie/openwebui-extensions/blob/main/scripts/DEPLOYMENT_GUIDE.md). --- diff --git a/docs/release-workflow.zh.md b/docs/release-workflow.zh.md index f1db1f8..4363d17 100644 --- a/docs/release-workflow.zh.md +++ b/docs/release-workflow.zh.md @@ -128,11 +128,13 @@ git push origin v1.0.0 ### release.yml **触发条件:** + - ⭐ 推送到 `main` 分支且修改了 `plugins/**/*.py`(自动发布) - 手动触发 (workflow_dispatch) - 推送版本标签 (`v*`) **动作:** + 1. 检测与上次 Release 的版本变化 2. 收集更新的插件文件 3. 生成发布说明(含提交记录) @@ -141,9 +143,11 @@ git push origin v1.0.0 ### plugin-version-check.yml **触发条件:** + - 修改 `plugins/**/*.py` 的 Pull Request **动作:** + 1. 比较基础分支和 PR 的插件版本 2. 检查是否有版本更新 3. 检查 PR 描述是否足够详细 @@ -206,7 +210,7 @@ echo "url=http://localhost:3000" >> scripts/.env python scripts/install_all_plugins.py ``` -详细说明请参考 [部署指南](./scripts/DEPLOYMENT_GUIDE.md)。 +详细说明请参考 [部署指南](https://github.com/Fu-Jie/openwebui-extensions/blob/main/scripts/DEPLOYMENT_GUIDE.md)。 --- diff --git a/requirements.txt b/requirements.txt index c880fae..93fe46f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,6 @@ # MkDocs Documentation Dependencies # Core MkDocs -mkdocs>=1.5.0 +mkdocs>=1.5.0,<2.0.0 # Material Theme for MkDocs mkdocs-material>=9.5.0