From 93a6c41c05da527a98c61e788232007ff80d00de Mon Sep 17 00:00:00 2001 From: fujie Date: Mon, 16 Mar 2026 01:29:18 +0800 Subject: [PATCH] docs(site): fix strict-build doc links - replace broken mirrored README asset links with GitHub URLs - keep mkdocs strict build passing after the README refresh Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- docs/plugins/actions/flash-card.md | 2 +- docs/plugins/actions/flash-card.zh.md | 2 +- docs/plugins/filters/async-context-compression.md | 2 +- docs/plugins/filters/async-context-compression.zh.md | 2 +- docs/plugins/filters/folder-memory.md | 2 +- docs/plugins/filters/folder-memory.zh.md | 2 +- docs/plugins/tools/openwebui-skills-manager.md | 2 +- docs/plugins/tools/openwebui-skills-manager.zh.md | 2 +- docs/zh/future_plugin_development_roadmap_cn.md | 2 ++ docs/zh/plugin_development_guide.md | 11 +++++++++++ plugins/actions/flash-card/README.md | 2 +- plugins/actions/flash-card/README_CN.md | 2 +- plugins/filters/async-context-compression/README.md | 2 +- .../filters/async-context-compression/README_CN.md | 2 +- plugins/filters/folder-memory/README.md | 2 +- plugins/filters/folder-memory/README_CN.md | 2 +- plugins/tools/openwebui-skills-manager/README.md | 2 +- plugins/tools/openwebui-skills-manager/README_CN.md | 2 +- 18 files changed, 29 insertions(+), 16 deletions(-) diff --git a/docs/plugins/actions/flash-card.md b/docs/plugins/actions/flash-card.md index ecf2ecf..7dbb711 100644 --- a/docs/plugins/actions/flash-card.md +++ b/docs/plugins/actions/flash-card.md @@ -53,7 +53,7 @@ If this plugin has been useful, a star on [OpenWebUI Extensions](https://github. ## Preview 📸 -![Flash Card Example](flash_card.png) +![Flash Card Example](https://raw.githubusercontent.com/Fu-Jie/openwebui-extensions/main/plugins/actions/flash-card/flash_card.png) ## Changelog diff --git a/docs/plugins/actions/flash-card.zh.md b/docs/plugins/actions/flash-card.zh.md index 268ad30..e893cfd 100644 --- a/docs/plugins/actions/flash-card.zh.md +++ b/docs/plugins/actions/flash-card.zh.md @@ -51,7 +51,7 @@ ## 预览 📸 -![闪记卡示例](flash_card_cn.png) +![闪记卡示例](https://raw.githubusercontent.com/Fu-Jie/openwebui-extensions/main/plugins/actions/flash-card/flash_card_cn.png) ## 更新日志 diff --git a/docs/plugins/filters/async-context-compression.md b/docs/plugins/filters/async-context-compression.md index 0489b53..7548200 100644 --- a/docs/plugins/filters/async-context-compression.md +++ b/docs/plugins/filters/async-context-compression.md @@ -158,6 +158,6 @@ If this plugin has been useful, a star on [OpenWebUI Extensions](https://github. ## Changelog -See [`v1.5.0` Release Notes](./v1.5.0.md) for the release-specific summary. +See [`v1.5.0` Release Notes](https://github.com/Fu-Jie/openwebui-extensions/blob/main/plugins/filters/async-context-compression/v1.5.0.md) for the release-specific summary. See the full history on GitHub: [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions) diff --git a/docs/plugins/filters/async-context-compression.zh.md b/docs/plugins/filters/async-context-compression.zh.md index 418e948..15f1fe5 100644 --- a/docs/plugins/filters/async-context-compression.zh.md +++ b/docs/plugins/filters/async-context-compression.zh.md @@ -196,6 +196,6 @@ flowchart TD ## 更新日志 -请查看 [`v1.5.0` 版本发布说明](./v1.5.0_CN.md) 获取本次版本的独立发布摘要。 +请查看 [`v1.5.0` 版本发布说明](https://github.com/Fu-Jie/openwebui-extensions/blob/main/plugins/filters/async-context-compression/v1.5.0_CN.md) 获取本次版本的独立发布摘要。 完整历史请查看 GitHub 项目： [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions) diff --git a/docs/plugins/filters/folder-memory.md b/docs/plugins/filters/folder-memory.md index f693f7e..c045848 100644 --- a/docs/plugins/filters/folder-memory.md +++ b/docs/plugins/filters/folder-memory.md @@ -60,7 +60,7 @@ If this plugin has been useful, a star on [OpenWebUI Extensions](https://github. ## 🗺️ Roadmap -See [ROADMAP.md](./ROADMAP.md) for future plans, including "Project Knowledge" collection. +See [ROADMAP.md](https://github.com/Fu-Jie/openwebui-extensions/blob/main/plugins/filters/folder-memory/ROADMAP.md) for future plans, including "Project Knowledge" collection. ## Changelog diff --git a/docs/plugins/filters/folder-memory.zh.md b/docs/plugins/filters/folder-memory.zh.md index 6d7f32d..18ea831 100644 --- a/docs/plugins/filters/folder-memory.zh.md +++ b/docs/plugins/filters/folder-memory.zh.md @@ -62,7 +62,7 @@ ## 🗺️ 路线图 -查看 [ROADMAP.md](./ROADMAP.md) 了解未来计划，包括“项目知识”收集功能。 +查看 [ROADMAP.md](https://github.com/Fu-Jie/openwebui-extensions/blob/main/plugins/filters/folder-memory/ROADMAP.md) 了解未来计划，包括“项目知识”收集功能。 ## 更新日志 diff --git a/docs/plugins/tools/openwebui-skills-manager.md b/docs/plugins/tools/openwebui-skills-manager.md index f6b64dc..410085b 100644 --- a/docs/plugins/tools/openwebui-skills-manager.md +++ b/docs/plugins/tools/openwebui-skills-manager.md @@ -265,7 +265,7 @@ All installations enforce: | `SHOW_STATUS` | `True` | Show operation status updates in OpenWebUI status bar. | | `ALLOW_OVERWRITE_ON_CREATE` | `False` | Allow `create_skill`/`install_skill` to overwrite same-name skill by default. | | `INSTALL_FETCH_TIMEOUT` | `12.0` | URL fetch timeout in seconds for skill installation. | -| `TRUSTED_DOMAINS` | `github.com,huggingface.co,githubusercontent.com` | Comma-separated list of primary trusted domains for downloads (always enforced). Subdomains automatically allowed (e.g., `github.com` allows `api.github.com`). See [Domain Whitelist Guide](docs/DOMAIN_WHITELIST.md). | +| `TRUSTED_DOMAINS` | `github.com,huggingface.co,githubusercontent.com` | Comma-separated list of primary trusted domains for downloads (always enforced). Subdomains automatically allowed (e.g., `github.com` allows `api.github.com`). See [Domain Whitelist Guide](https://github.com/Fu-Jie/openwebui-extensions/blob/main/plugins/tools/openwebui-skills-manager/docs/DOMAIN_WHITELIST.md). | ## Supported Tool Methods diff --git a/docs/plugins/tools/openwebui-skills-manager.zh.md b/docs/plugins/tools/openwebui-skills-manager.zh.md index 596fbfb..d2f5aeb 100644 --- a/docs/plugins/tools/openwebui-skills-manager.zh.md +++ b/docs/plugins/tools/openwebui-skills-manager.zh.md @@ -265,7 +265,7 @@ description: "做一些有用的事" | `SHOW_STATUS` | `True` | 是否在 OpenWebUI 状态栏显示操作状态。 | | `ALLOW_OVERWRITE_ON_CREATE` | `False` | 是否允许 `create_skill`/`install_skill` 默认覆盖同名技能。 | | `INSTALL_FETCH_TIMEOUT` | `12.0` | 从 URL 安装技能时的请求超时时间（秒）。 | -| `TRUSTED_DOMAINS` | `github.com,huggingface.co,githubusercontent.com` | 逗号分隔的主信任域名清单（**必须启用**）。子域名会自动放行（如 `github.com` 允许 `api.github.com`）。详见 [域名白名单指南](docs/DOMAIN_WHITELIST.md)。 | +| `TRUSTED_DOMAINS` | `github.com,huggingface.co,githubusercontent.com` | 逗号分隔的主信任域名清单（**必须启用**）。子域名会自动放行（如 `github.com` 允许 `api.github.com`）。详见 [域名白名单指南](https://github.com/Fu-Jie/openwebui-extensions/blob/main/plugins/tools/openwebui-skills-manager/docs/DOMAIN_WHITELIST.md)。 | ## 支持的方法 diff --git a/docs/zh/future_plugin_development_roadmap_cn.md b/docs/zh/future_plugin_development_roadmap_cn.md index 70baab2..3f89ba5 100644 --- a/docs/zh/future_plugin_development_roadmap_cn.md +++ b/docs/zh/future_plugin_development_roadmap_cn.md @@ -2341,6 +2341,7 @@ B站（长视频） 抖音（短视频） 公众号（图文 --- + ## 技术实现指南 ### 通用开发模式 @@ -2492,6 +2493,7 @@ class CacheManager: --- + ## 开发优先级建议 基于实用性、技术可行性和市场需求，推荐以下开发优先级： diff --git a/docs/zh/plugin_development_guide.md b/docs/zh/plugin_development_guide.md index cc4ca2f..6aba414 100644 --- a/docs/zh/plugin_development_guide.md +++ b/docs/zh/plugin_development_guide.md @@ -18,6 +18,7 @@ --- + ## 1. 插件开发快速入门 ### 1.1 什么是 OpenWebUI 插件？ @@ -67,6 +68,7 @@ class Action: --- + ## 2. 核心概念与 SDK 详解 ### 2.1 ⚠️ 重要：同步与异步 @@ -111,8 +113,10 @@ class Filter: --- + ## 3. 插件类型深度解析 + ### 3.1 Action (动作) **定位**：在消息下方添加按钮，用户点击触发。 @@ -138,6 +142,7 @@ async def action(self, body, __event_call__): await __event_call__({"type": "execute", "data": {"code": js}}) ``` + ### 3.2 Filter (过滤器) **定位**：中间件，拦截并修改请求/响应。 @@ -159,6 +164,7 @@ async def inlet(self, body, __metadata__): return body ``` + ### 3.3 Pipe (管道) **定位**：自定义模型/代理。 @@ -181,6 +187,7 @@ class Pipe: --- + ## 4. 高级开发模式 ### 4.1 Pipe 与 Filter 协同 @@ -208,6 +215,7 @@ async def background_job(self, chat_id): --- + ## 5. 最佳实践与设计原则 ### 5.1 命名与定位 @@ -237,6 +245,7 @@ except Exception as e: --- + ## 6. 仓库规范（openwebui-extensions） ### 6.1 单文件 i18n 规范 @@ -325,6 +334,7 @@ except Exception as e: --- + ## 7. 自定义 Agents 设计建议 ### 7.1 推荐架构（适合你的项目） @@ -356,6 +366,7 @@ except Exception as e: --- + ## 8. 故障排查 * **HTML 不显示？** 确保包裹在 ` ```html ... ``` ` 代码块中。 diff --git a/plugins/actions/flash-card/README.md b/plugins/actions/flash-card/README.md index ecf2ecf..7dbb711 100644 --- a/plugins/actions/flash-card/README.md +++ b/plugins/actions/flash-card/README.md @@ -53,7 +53,7 @@ If this plugin has been useful, a star on [OpenWebUI Extensions](https://github. ## Preview 📸 -![Flash Card Example](flash_card.png) +![Flash Card Example](https://raw.githubusercontent.com/Fu-Jie/openwebui-extensions/main/plugins/actions/flash-card/flash_card.png) ## Changelog diff --git a/plugins/actions/flash-card/README_CN.md b/plugins/actions/flash-card/README_CN.md index 268ad30..e893cfd 100644 --- a/plugins/actions/flash-card/README_CN.md +++ b/plugins/actions/flash-card/README_CN.md @@ -51,7 +51,7 @@ ## 预览 📸 -![闪记卡示例](flash_card_cn.png) +![闪记卡示例](https://raw.githubusercontent.com/Fu-Jie/openwebui-extensions/main/plugins/actions/flash-card/flash_card_cn.png) ## 更新日志 diff --git a/plugins/filters/async-context-compression/README.md b/plugins/filters/async-context-compression/README.md index 0489b53..7548200 100644 --- a/plugins/filters/async-context-compression/README.md +++ b/plugins/filters/async-context-compression/README.md @@ -158,6 +158,6 @@ If this plugin has been useful, a star on [OpenWebUI Extensions](https://github. ## Changelog -See [`v1.5.0` Release Notes](./v1.5.0.md) for the release-specific summary. +See [`v1.5.0` Release Notes](https://github.com/Fu-Jie/openwebui-extensions/blob/main/plugins/filters/async-context-compression/v1.5.0.md) for the release-specific summary. See the full history on GitHub: [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions) diff --git a/plugins/filters/async-context-compression/README_CN.md b/plugins/filters/async-context-compression/README_CN.md index 418e948..15f1fe5 100644 --- a/plugins/filters/async-context-compression/README_CN.md +++ b/plugins/filters/async-context-compression/README_CN.md @@ -196,6 +196,6 @@ flowchart TD ## 更新日志 -请查看 [`v1.5.0` 版本发布说明](./v1.5.0_CN.md) 获取本次版本的独立发布摘要。 +请查看 [`v1.5.0` 版本发布说明](https://github.com/Fu-Jie/openwebui-extensions/blob/main/plugins/filters/async-context-compression/v1.5.0_CN.md) 获取本次版本的独立发布摘要。 完整历史请查看 GitHub 项目： [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions) diff --git a/plugins/filters/folder-memory/README.md b/plugins/filters/folder-memory/README.md index f693f7e..c045848 100644 --- a/plugins/filters/folder-memory/README.md +++ b/plugins/filters/folder-memory/README.md @@ -60,7 +60,7 @@ If this plugin has been useful, a star on [OpenWebUI Extensions](https://github. ## 🗺️ Roadmap -See [ROADMAP.md](./ROADMAP.md) for future plans, including "Project Knowledge" collection. +See [ROADMAP.md](https://github.com/Fu-Jie/openwebui-extensions/blob/main/plugins/filters/folder-memory/ROADMAP.md) for future plans, including "Project Knowledge" collection. ## Changelog diff --git a/plugins/filters/folder-memory/README_CN.md b/plugins/filters/folder-memory/README_CN.md index 6d7f32d..18ea831 100644 --- a/plugins/filters/folder-memory/README_CN.md +++ b/plugins/filters/folder-memory/README_CN.md @@ -62,7 +62,7 @@ ## 🗺️ 路线图 -查看 [ROADMAP.md](./ROADMAP.md) 了解未来计划，包括“项目知识”收集功能。 +查看 [ROADMAP.md](https://github.com/Fu-Jie/openwebui-extensions/blob/main/plugins/filters/folder-memory/ROADMAP.md) 了解未来计划，包括“项目知识”收集功能。 ## 更新日志 diff --git a/plugins/tools/openwebui-skills-manager/README.md b/plugins/tools/openwebui-skills-manager/README.md index f6b64dc..410085b 100644 --- a/plugins/tools/openwebui-skills-manager/README.md +++ b/plugins/tools/openwebui-skills-manager/README.md @@ -265,7 +265,7 @@ All installations enforce: | `SHOW_STATUS` | `True` | Show operation status updates in OpenWebUI status bar. | | `ALLOW_OVERWRITE_ON_CREATE` | `False` | Allow `create_skill`/`install_skill` to overwrite same-name skill by default. | | `INSTALL_FETCH_TIMEOUT` | `12.0` | URL fetch timeout in seconds for skill installation. | -| `TRUSTED_DOMAINS` | `github.com,huggingface.co,githubusercontent.com` | Comma-separated list of primary trusted domains for downloads (always enforced). Subdomains automatically allowed (e.g., `github.com` allows `api.github.com`). See [Domain Whitelist Guide](docs/DOMAIN_WHITELIST.md). | +| `TRUSTED_DOMAINS` | `github.com,huggingface.co,githubusercontent.com` | Comma-separated list of primary trusted domains for downloads (always enforced). Subdomains automatically allowed (e.g., `github.com` allows `api.github.com`). See [Domain Whitelist Guide](https://github.com/Fu-Jie/openwebui-extensions/blob/main/plugins/tools/openwebui-skills-manager/docs/DOMAIN_WHITELIST.md). | ## Supported Tool Methods diff --git a/plugins/tools/openwebui-skills-manager/README_CN.md b/plugins/tools/openwebui-skills-manager/README_CN.md index 596fbfb..d2f5aeb 100644 --- a/plugins/tools/openwebui-skills-manager/README_CN.md +++ b/plugins/tools/openwebui-skills-manager/README_CN.md @@ -265,7 +265,7 @@ description: "做一些有用的事" | `SHOW_STATUS` | `True` | 是否在 OpenWebUI 状态栏显示操作状态。 | | `ALLOW_OVERWRITE_ON_CREATE` | `False` | 是否允许 `create_skill`/`install_skill` 默认覆盖同名技能。 | | `INSTALL_FETCH_TIMEOUT` | `12.0` | 从 URL 安装技能时的请求超时时间（秒）。 | -| `TRUSTED_DOMAINS` | `github.com,huggingface.co,githubusercontent.com` | 逗号分隔的主信任域名清单（**必须启用**）。子域名会自动放行（如 `github.com` 允许 `api.github.com`）。详见 [域名白名单指南](docs/DOMAIN_WHITELIST.md)。 | +| `TRUSTED_DOMAINS` | `github.com,huggingface.co,githubusercontent.com` | 逗号分隔的主信任域名清单（**必须启用**）。子域名会自动放行（如 `github.com` 允许 `api.github.com`）。详见 [域名白名单指南](https://github.com/Fu-Jie/openwebui-extensions/blob/main/plugins/tools/openwebui-skills-manager/docs/DOMAIN_WHITELIST.md)。 | ## 支持的方法