Files
Fu-Jie_openwebui-extensions/docs/PLUGIN_README_TEMPLATE.md
fujie ad2773e8f1 Update plugin documentation for various filters and actions
- Updated README.md and README_CN.md for the infographic plugin to reflect new features and bug fixes in version 1.5.0, including context-aware generation and language synchronization.
- Revised README.md and README_CN.md for the smart mind map plugin to include support for user feedback and a changelog.
- Enhanced README.md and README_CN.md for the async context compression filter with critical fixes and improved compatibility details.
- Introduced initial release notes for the folder memory filter, detailing its core features and installation instructions.
- Updated markdown normalizer documentation to synchronize version numbers and improve clarity on configuration options.
- Revised GitHub Copilot SDK documentation to enhance installation instructions and troubleshooting sections, including a new changelog.
2026-01-29 03:22:21 +08:00

2.1 KiB

[Plugin Name] [Optional Emoji]

[Brief description of what the plugin does. Keep it concise and engaging.]

Author: Fu-Jie | Version: 1.0.0 | Project: Awesome OpenWebUI | License: MIT

What's New

v1.0.0

  • Initial Release: Released the first version of the plugin.
  • [Feature Name]: [Brief description of the feature].

Key Features 🔑

  • [Feature 1]: [Description of feature 1].
  • [Feature 2]: [Description of feature 2].
  • [Feature 3]: [Description of feature 3].

How to Use 🛠️

  1. Install: Add the plugin to your OpenWebUI instance.
  2. Configure: Adjust settings in the Valves menu (optional).
  3. [Action Step]: Describe how to trigger or use the plugin.
  4. [Result Step]: Describe the expected outcome.

Configuration (Valves) ⚙️

Valve Default Description
VALVE_NAME Default Value Description of what this setting does.
ANOTHER_VALVE True Another setting description.

Support

If this plugin has been useful, a star on Awesome OpenWebUI is a big motivation for me. Thank you for the support.

Troubleshooting

  • Plugin not working?: Check if the filter/action is enabled in the model settings.
  • Debug Logs: Enable SHOW_DEBUG_LOG in Valves and check the browser console (F12) for detailed logs.
  • Error Messages: If you see an error, please copy the full error message and report it.
  • Submit an Issue: If you encounter any problems, please submit an issue on GitHub: Awesome OpenWebUI Issues

Changelog

See the full history on GitHub: Awesome OpenWebUI