From dea3f578de7af0a3f87f6bfda37207028c6ed0d3 Mon Sep 17 00:00:00 2001 From: thiswillbeyourgithub <26625900+thiswillbeyourgithub@users.noreply.github.com> Date: Fri, 9 May 2025 10:50:44 +0200 Subject: [PATCH] new: move valve to its own section Currently, the tabs-shared folder mechanism seems broken: the valve documentation does not appear on the website. Additionaly, valves are relevant to tools too. Signed-off-by: thiswillbeyourgithub <26625900+thiswillbeyourgithub@users.noreply.github.com> --- docs/features/plugin/migration/index.mdx | 2 +- .../tab-shared/Common.md => valves/index.mdx} | 12 +++++++++--- 2 files changed, 10 insertions(+), 4 deletions(-) rename docs/features/plugin/{functions/tab-shared/Common.md => valves/index.mdx} (96%) diff --git a/docs/features/plugin/migration/index.mdx b/docs/features/plugin/migration/index.mdx index e045439..575515f 100644 --- a/docs/features/plugin/migration/index.mdx +++ b/docs/features/plugin/migration/index.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 4 title: "🚚 Migrating Tools & Functions: 0.4 to 0.5" --- diff --git a/docs/features/plugin/functions/tab-shared/Common.md b/docs/features/plugin/valves/index.mdx similarity index 96% rename from docs/features/plugin/functions/tab-shared/Common.md rename to docs/features/plugin/valves/index.mdx index 51b7d8a..272c192 100644 --- a/docs/features/plugin/functions/tab-shared/Common.md +++ b/docs/features/plugin/valves/index.mdx @@ -1,8 +1,14 @@ -## Shared Function Components +--- +sidebar_position: 3 +title: "🔄 Valves & UserValves" +--- -### Valves and UserValves - (optional, but HIGHLY encouraged) +## Valves & UserValves -Valves and UserValves are used to allow users to provide dynamic details such as an API key or a configuration option. These will create a fillable field or a bool switch in the GUI menu for the given function. + +Valves and UserValves are used to allow users to provide dynamic details such as an API key or a configuration option. These will create a fillable field or a bool switch in the GUI menu for the given function. They are always optional, but HIGHLY encouraged. + +Hence, Valves and UserValves class can be defined in either a `Pipe`, `Pipeline`, `Filter` or `Tools` class. Valves are configurable by admins alone via the Tools or Functions menus. On the other hand UserValves are configurable by any users directly from a chat session.