Add MkDocs documentation portal with Material theme and CI/CD workflow
Co-authored-by: Fu-Jie <33599649+Fu-Jie@users.noreply.github.com>
This commit is contained in:
59
docs/enhancements/index.md
Normal file
59
docs/enhancements/index.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# Enhancements
|
||||
|
||||
Tips, tricks, and advanced configurations to optimize your OpenWebUI experience.
|
||||
|
||||
---
|
||||
|
||||
## Enhancement Categories
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :material-tune:{ .lg .middle } **Optimization Guide**
|
||||
|
||||
---
|
||||
|
||||
Learn how to optimize OpenWebUI for better performance, customization, and workflows.
|
||||
|
||||
[:octicons-arrow-right-24: View Guide](guide.md)
|
||||
|
||||
- :material-puzzle:{ .lg .middle } **Plugin Integration**
|
||||
|
||||
---
|
||||
|
||||
Best practices for combining multiple plugins effectively.
|
||||
|
||||
[:octicons-arrow-right-24: Browse Plugins](../plugins/index.md)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## Quick Tips
|
||||
|
||||
### Performance
|
||||
|
||||
- :material-speedometer: Enable caching for frequently used models
|
||||
- :material-memory: Optimize context window usage with compression filters
|
||||
- :material-lightning-bolt: Use streaming for faster perceived response times
|
||||
|
||||
### Customization
|
||||
|
||||
- :material-palette: Customize themes and appearance
|
||||
- :material-keyboard: Set up keyboard shortcuts
|
||||
- :material-cog: Configure default model settings
|
||||
|
||||
### Workflow
|
||||
|
||||
- :material-robot: Create custom prompts for repeated tasks
|
||||
- :material-filter: Use filters for consistent formatting
|
||||
- :material-export: Set up export workflows for documentation
|
||||
|
||||
---
|
||||
|
||||
## Featured Guides
|
||||
|
||||
| Guide | Description |
|
||||
|-------|-------------|
|
||||
| [Complete Optimization Guide](guide.md) | Comprehensive tips for better OpenWebUI usage |
|
||||
| [Plugin Development](../development/index.md) | Create your own plugins |
|
||||
| [Prompt Engineering](../prompts/library.md) | Master the art of prompting |
|
||||
Reference in New Issue
Block a user