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:
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 }
|
||||
Reference in New Issue
Block a user