34 lines
1.1 KiB
Markdown
34 lines
1.1 KiB
Markdown
---
|
|
description: Standards for OpenWebUI Plugin Development, specifically README formatting.
|
|
globs: plugins/**
|
|
always_on: true
|
|
---
|
|
# Plugin Development Standards
|
|
|
|
## README Documentation
|
|
|
|
All plugins MUST follow the standard README template.
|
|
|
|
**Reference Template**: @docs/PLUGIN_README_TEMPLATE.md
|
|
|
|
### Language Requirements
|
|
|
|
- **English Version (`README.md`)**: The primary documentation source. Must follow the template strictly.
|
|
- **Chinese Version (`README_CN.md`)**: MUST be translated based on the English version (`README.md`) to ensure consistency in structure and content.
|
|
|
|
### Metadata Requirements
|
|
|
|
The metadata line must follow this format:
|
|
`**Author:** [Name](Link) | **Version:** [X.Y.Z] | **Project:** [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions) | **License:** MIT`
|
|
|
|
### Structure Checklist
|
|
|
|
1. **Title & Description**
|
|
2. **Metadata Line** (Author, Version, Project, License)
|
|
3. **Preview** (Screenshots/GIFs)
|
|
4. **What's New** (Keep last 3 versions)
|
|
5. **Key Features**
|
|
6. **How to Use**
|
|
7. **Configuration (Valves)**
|
|
8. **Troubleshooting** (Must include link to GitHub Issues)
|