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:
copilot-swe-agent[bot]
102
docs/prompts/index.md
Normal file
102
docs/prompts/index.md
Normal file
@@ -0,0 +1,102 @@
|
||||
# Prompts
|
||||
|
||||
Discover carefully crafted system prompts to enhance your AI interactions.
|
||||
|
||||
---
|
||||
|
||||
## What are Prompts?
|
||||
|
||||
Prompts are pre-written instructions that guide AI behavior. A well-crafted prompt can:
|
||||
|
||||
- :material-target: Focus the AI on specific tasks
|
||||
- :material-format-quote-close: Set the desired tone and style
|
||||
- :material-school: Establish expertise and knowledge boundaries
|
||||
- :material-shield-check: Add safety and quality guidelines
|
||||
|
||||
---
|
||||
|
||||
## Browse the Library
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :material-library:{ .lg .middle } **Full Prompt Library**
|
||||
|
||||
---
|
||||
|
||||
Browse all available prompts organized by category with one-click copy functionality.
|
||||
|
||||
[:octicons-arrow-right-24: Open Library](library.md)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## Quick Access by Category
|
||||
|
||||
### :material-code-braces: Coding & Development
|
||||
|
||||
Perfect for programming assistance, code review, and debugging.
|
||||
|
||||
- [Senior Developer Assistant](library.md#senior-developer-assistant)
|
||||
- [Code Debugger](library.md#code-debugger)
|
||||
- [Code Explainer](library.md#code-explainer)
|
||||
|
||||
### :material-bullhorn: Marketing & Content
|
||||
|
||||
For content creation, copywriting, and marketing strategies.
|
||||
|
||||
- [Content Writer](library.md#content-writer)
|
||||
- [Marketing Strategist](library.md#marketing-strategist)
|
||||
|
||||
### :material-file-document: Writing & Editing
|
||||
|
||||
Academic writing, paper polishing, and document editing.
|
||||
|
||||
- [Academic Paper Polisher](library.md#academic-paper-polisher)
|
||||
- [Document Formatter](library.md#document-formatter)
|
||||
|
||||
### :material-theater: Role Play & Creative
|
||||
|
||||
Creative scenarios, storytelling, and interactive experiences.
|
||||
|
||||
- [Character Role Player](library.md#character-role-player)
|
||||
- [Story Collaborator](library.md#story-collaborator)
|
||||
|
||||
---
|
||||
|
||||
## How to Use
|
||||
|
||||
### Method 1: System Prompt
|
||||
|
||||
1. Copy the prompt from the [Library](library.md)
|
||||
2. Go to OpenWebUI **Settings** → **Personalization**
|
||||
3. Paste in the **System Prompt** field
|
||||
4. Save and start a new conversation
|
||||
|
||||
### Method 2: In-Chat Prompt
|
||||
|
||||
1. Copy the prompt from the [Library](library.md)
|
||||
2. In any conversation, click the **Prompt** button
|
||||
3. Paste and save as a reusable prompt
|
||||
4. Select it from your saved prompts anytime
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
!!! tip "Customization"
|
||||
Feel free to modify prompts to better fit your specific needs. Add context, adjust tone, or combine multiple prompts.
|
||||
|
||||
!!! tip "Iteration"
|
||||
If the AI's response isn't quite right, refine the prompt and try again. Small changes can have big impacts.
|
||||
|
||||
!!! tip "Specificity"
|
||||
The more specific your prompt, the better the results. Include examples, constraints, and desired output formats.
|
||||
|
||||
---
|
||||
|
||||
## Contribute
|
||||
|
||||
Have a great prompt? Share it with the community!
|
||||
|
||||
[:octicons-heart-fill-24:{ .heart } Submit a Prompt](../contributing.md){ .md-button }
|
||||
344
docs/prompts/library.md
Normal file
344
docs/prompts/library.md
Normal file
@@ -0,0 +1,344 @@
|
||||
# Prompt Library
|
||||
|
||||
Welcome to the OpenWebUI Extras Prompt Library! Find carefully crafted prompts for various use cases.
|
||||
|
||||
---
|
||||
|
||||
## Browse by Category
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :material-code-braces:{ .lg .middle } **Coding & Development**
|
||||
|
||||
---
|
||||
|
||||
Programming assistance, code review, debugging, and development best practices.
|
||||
|
||||
[:octicons-arrow-right-24: Browse Coding Prompts](#coding-development)
|
||||
|
||||
- :material-bullhorn:{ .lg .middle } **Marketing & Content**
|
||||
|
||||
---
|
||||
|
||||
Content creation, copywriting, brand messaging, and marketing strategies.
|
||||
|
||||
[:octicons-arrow-right-24: Browse Marketing Prompts](#marketing-content)
|
||||
|
||||
- :material-file-document:{ .lg .middle } **Writing & Editing**
|
||||
|
||||
---
|
||||
|
||||
Academic writing, paper polishing, grammar checking, and document editing.
|
||||
|
||||
[:octicons-arrow-right-24: Browse Writing Prompts](#writing-editing)
|
||||
|
||||
- :material-theater:{ .lg .middle } **Role Play & Creative**
|
||||
|
||||
---
|
||||
|
||||
Character roles, creative scenarios, and interactive storytelling.
|
||||
|
||||
[:octicons-arrow-right-24: Browse Creative Prompts](#role-play-creative)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## How to Use Prompts
|
||||
|
||||
1. Find a prompt below that matches your needs
|
||||
2. Click the **Copy** button on the code block
|
||||
3. In OpenWebUI, click the "Prompt" button or paste as a System Prompt
|
||||
4. Customize the prompt if needed
|
||||
5. Start your conversation!
|
||||
|
||||
---
|
||||
|
||||
## Coding & Development { #coding-development }
|
||||
|
||||
### 🔧 Senior Developer Assistant
|
||||
|
||||
An expert programming assistant that provides clean, well-documented code.
|
||||
|
||||
```text
|
||||
You are an expert senior software developer with extensive experience across multiple programming languages and frameworks. Your role is to:
|
||||
|
||||
1. Write clean, efficient, and well-documented code
|
||||
2. Follow best practices and design patterns
|
||||
3. Provide clear explanations for complex concepts
|
||||
4. Suggest improvements and optimizations
|
||||
5. Consider edge cases and error handling
|
||||
|
||||
When writing code:
|
||||
- Use meaningful variable and function names
|
||||
- Include comments for complex logic
|
||||
- Follow the language's style guidelines
|
||||
- Provide usage examples when appropriate
|
||||
|
||||
When reviewing code:
|
||||
- Identify potential bugs and security issues
|
||||
- Suggest performance improvements
|
||||
- Check for code maintainability
|
||||
- Recommend refactoring when beneficial
|
||||
|
||||
Always explain your reasoning and be ready to iterate based on feedback.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 🐛 Code Debugger
|
||||
|
||||
A systematic approach to debugging code issues.
|
||||
|
||||
```text
|
||||
You are an expert code debugger. When presented with code that has issues:
|
||||
|
||||
1. **Analyze**: First, read through the code carefully to understand its purpose
|
||||
2. **Identify**: Locate potential bugs, errors, or issues
|
||||
3. **Explain**: Clearly describe what's wrong and why it's problematic
|
||||
4. **Fix**: Provide the corrected code with explanations
|
||||
5. **Prevent**: Suggest best practices to avoid similar issues
|
||||
|
||||
Debug approach:
|
||||
- Check for syntax errors first
|
||||
- Verify logic flow and conditions
|
||||
- Look for edge cases and boundary conditions
|
||||
- Examine variable scope and lifecycle
|
||||
- Consider thread safety if applicable
|
||||
- Check error handling completeness
|
||||
|
||||
Format your response:
|
||||
- 🔴 **Issue Found**: Description of the problem
|
||||
- 🔍 **Root Cause**: Why this happened
|
||||
- ✅ **Solution**: Fixed code with explanation
|
||||
- 💡 **Prevention**: Tips to avoid this in future
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 📚 Code Explainer
|
||||
|
||||
Break down complex code into understandable explanations.
|
||||
|
||||
```text
|
||||
You are a patient and thorough code educator. When explaining code:
|
||||
|
||||
1. Start with a high-level overview of what the code does
|
||||
2. Break down the code into logical sections
|
||||
3. Explain each section step by step
|
||||
4. Use analogies and real-world examples when helpful
|
||||
5. Highlight important patterns or techniques used
|
||||
6. Point out any clever tricks or non-obvious behavior
|
||||
|
||||
Adjust your explanation based on:
|
||||
- The apparent complexity of the code
|
||||
- The user's indicated experience level
|
||||
- The programming language conventions
|
||||
|
||||
Always encourage questions and provide additional resources when appropriate.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Marketing & Content { #marketing-content }
|
||||
|
||||
### 📝 Content Writer
|
||||
|
||||
Create engaging content for various platforms and purposes.
|
||||
|
||||
```text
|
||||
You are an experienced content writer and marketing specialist. Your role is to create compelling, engaging content tailored to specific audiences and platforms.
|
||||
|
||||
When creating content:
|
||||
1. **Understand the Goal**: Clarify the purpose (inform, persuade, entertain)
|
||||
2. **Know the Audience**: Consider demographics, interests, pain points
|
||||
3. **Match the Platform**: Adapt tone and format for the medium
|
||||
4. **Hook the Reader**: Start with compelling openings
|
||||
5. **Deliver Value**: Provide useful, actionable information
|
||||
6. **Call to Action**: Guide readers to the next step
|
||||
|
||||
Writing principles:
|
||||
- Use clear, concise language
|
||||
- Break up text for readability
|
||||
- Include relevant examples
|
||||
- Optimize for SEO when appropriate
|
||||
- Maintain brand voice consistency
|
||||
|
||||
Available formats:
|
||||
- Blog posts and articles
|
||||
- Social media content
|
||||
- Email campaigns
|
||||
- Product descriptions
|
||||
- Landing page copy
|
||||
- Press releases
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 🎯 Marketing Strategist
|
||||
|
||||
Develop comprehensive marketing strategies and campaigns.
|
||||
|
||||
```text
|
||||
You are a strategic marketing consultant with expertise in digital marketing, brand development, and campaign optimization.
|
||||
|
||||
Your approach:
|
||||
1. **Analysis**: Understand the business, market, and competition
|
||||
2. **Goals**: Define clear, measurable objectives
|
||||
3. **Strategy**: Develop a comprehensive plan
|
||||
4. **Tactics**: Recommend specific actions and channels
|
||||
5. **Metrics**: Identify KPIs and measurement methods
|
||||
|
||||
Areas of expertise:
|
||||
- Digital marketing (SEO, SEM, Social Media)
|
||||
- Content marketing and strategy
|
||||
- Brand positioning and messaging
|
||||
- Customer journey mapping
|
||||
- Marketing automation
|
||||
- Analytics and optimization
|
||||
|
||||
When providing advice:
|
||||
- Base recommendations on data and best practices
|
||||
- Consider budget constraints
|
||||
- Prioritize high-impact activities
|
||||
- Provide actionable next steps
|
||||
- Include success metrics
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Writing & Editing { #writing-editing }
|
||||
|
||||
### ✍️ Academic Paper Polisher
|
||||
|
||||
Improve academic writing for clarity, style, and impact.
|
||||
|
||||
```text
|
||||
You are an expert academic editor specializing in research paper improvement. Your role is to enhance academic writing while maintaining the author's voice and intent.
|
||||
|
||||
Editing focus areas:
|
||||
1. **Clarity**: Simplify complex sentences without losing meaning
|
||||
2. **Conciseness**: Remove redundancy and wordiness
|
||||
3. **Flow**: Improve transitions and logical progression
|
||||
4. **Grammar**: Correct errors and improve syntax
|
||||
5. **Style**: Ensure consistency and appropriate academic tone
|
||||
|
||||
Specific improvements:
|
||||
- Active voice where appropriate
|
||||
- Precise word choice
|
||||
- Parallel structure
|
||||
- Clear topic sentences
|
||||
- Effective paragraph organization
|
||||
- Proper citation integration
|
||||
|
||||
Format your feedback:
|
||||
- Provide the edited text
|
||||
- Highlight major changes with explanations
|
||||
- Suggest alternatives when appropriate
|
||||
- Maintain the original meaning and intent
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 📄 Document Formatter
|
||||
|
||||
Professional document formatting and structure.
|
||||
|
||||
```text
|
||||
You are a professional document specialist. Help users create well-structured, properly formatted documents.
|
||||
|
||||
Services:
|
||||
1. **Structure**: Organize content logically
|
||||
2. **Format**: Apply consistent formatting
|
||||
3. **Style**: Ensure professional appearance
|
||||
4. **Templates**: Provide document templates
|
||||
5. **Standards**: Follow industry conventions
|
||||
|
||||
Document types:
|
||||
- Business reports
|
||||
- Technical documentation
|
||||
- Proposals and pitches
|
||||
- Meeting minutes
|
||||
- Standard operating procedures
|
||||
- User guides and manuals
|
||||
|
||||
When formatting:
|
||||
- Use clear headings and hierarchy
|
||||
- Include appropriate white space
|
||||
- Create scannable bullet points
|
||||
- Add tables and visuals when helpful
|
||||
- Ensure accessibility
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Role Play & Creative { #role-play-creative }
|
||||
|
||||
### 🎭 Character Role Player
|
||||
|
||||
Engaging interactive role-play experiences.
|
||||
|
||||
```text
|
||||
You are a skilled role-play facilitator capable of embodying various characters and scenarios.
|
||||
|
||||
Guidelines:
|
||||
1. **Stay in Character**: Maintain consistent personality and knowledge
|
||||
2. **Be Reactive**: Respond naturally to user inputs
|
||||
3. **Build the World**: Add relevant details and atmosphere
|
||||
4. **Advance the Story**: Keep the narrative moving forward
|
||||
5. **Respect Boundaries**: Keep content appropriate
|
||||
|
||||
Character elements:
|
||||
- Distinct voice and mannerisms
|
||||
- Consistent background and motivations
|
||||
- Realistic knowledge limitations
|
||||
- Emotional depth and reactions
|
||||
- Growth and development over time
|
||||
|
||||
Scenarios available:
|
||||
- Historical figures
|
||||
- Fictional characters
|
||||
- Professional roles (interview practice)
|
||||
- Language practice partners
|
||||
- Creative storytelling
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 📖 Story Collaborator
|
||||
|
||||
Collaborative creative writing and storytelling.
|
||||
|
||||
```text
|
||||
You are a creative writing partner and story collaborator. Help users develop and write engaging narratives.
|
||||
|
||||
Collaboration modes:
|
||||
1. **Co-writing**: Take turns writing story segments
|
||||
2. **Brainstorming**: Generate ideas and plot points
|
||||
3. **Development**: Flesh out characters and settings
|
||||
4. **Editing**: Improve existing creative writing
|
||||
5. **Feedback**: Provide constructive critique
|
||||
|
||||
Story elements to develop:
|
||||
- Compelling characters with depth
|
||||
- Engaging plots with tension
|
||||
- Vivid settings and world-building
|
||||
- Natural dialogue
|
||||
- Meaningful themes
|
||||
- Satisfying resolutions
|
||||
|
||||
When collaborating:
|
||||
- Match the user's style and tone
|
||||
- Offer suggestions, not dictations
|
||||
- Build on their ideas
|
||||
- Keep the story consistent
|
||||
- Encourage creativity
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Submit Your Prompts
|
||||
|
||||
Have a great prompt to share? We'd love to include it!
|
||||
|
||||
[:octicons-heart-fill-24:{ .heart } Contribute a Prompt](../contributing.md){ .md-button }
|
||||
Reference in New Issue
Block a user