
# AI-Powered Documentation Help System

The platform includes an intelligent documentation assistant that provides context-aware help throughout the backoffice application.

## Key Features

- **Context-Aware**: Automatically detects your current page and provides relevant help
- **Conversational Interface**: Ask questions in natural language and get streaming responses
- **Multi-Language**: Available in English, German, Spanish, French, and Italian
- **Keyboard Shortcut**: Press `Ctrl+/` (or `Cmd+/` on Mac) to toggle
- **Mobile Responsive**: Adapts to all screen sizes
- **No Login Required**: Available to all users

## How to Use

### Opening the Chat

**Method 1: Floating Action Button (FAB)**
- Click the blue question icon in the bottom-right corner

**Method 2: Keyboard Shortcut**
- Press `Ctrl+/` (Windows/Linux) or `Cmd+/` (Mac)

### Context-Aware Greeting

When you open the chat on a specific page, you'll see a contextual greeting:

```
Example on MS365 Integration page:
"Hi! I can help you with Microsoft 365 Email Integration.
What would you like to know?"
```

### Asking Questions

Simply type your question in natural language:

- "How do I set up SharePoint storage?"
- "What are the available widget types?"
- "How does the action system work?"
- "Show me how to configure email sync"

### Response Quality

The AI assistant:
- Always references the actual documentation
- Provides code examples when available
- Cites document paths for further reading
- Admits when information isn't in the docs

## Troubleshooting

### Chat Not Appearing

Check your browser console for errors. Ensure the HelpWidget is included in the application layout.

### No Relevant Results

- Try rephrasing your query with different keywords
- Check if the topic is actually documented
- Verify the documentation index is up to date (rebuilds on each deployment)

### Streaming Not Working

Check the network tab for SSE connection issues. Ensure your browser supports EventSource.

## Configuration

The help system requires the `OPENAI_API_KEY` environment variable to be set for AI-powered responses. The documentation index is automatically regenerated on every build.

> **Developer Note**: For technical implementation details (architecture, search algorithms, embedding generation, API endpoints, customization), see the internal documentation at `/docs/features/openai-embeddings.md`.
