ObsiViewer/docs/GEMINI/USER_GUIDE.md
Bruno Charest 59d8a9f83a feat: add multi-select notes and Gemini AI integration
- Implemented multi-selection for notes with Ctrl+click, long-press, and keyboard shortcuts (Ctrl+A, Escape)
- Added Gemini API integration with environment configuration and routes
- Enhanced code block UI with improved copy feedback animation and visual polish
- Added sort order toggle (asc/desc) for note lists with persistent state
2025-11-04 09:54:03 -05:00

326 lines
10 KiB
Markdown

# 👥 Interface IA Gemini - Guide Utilisateur
## 🎯 Introduction
L'interface IA Gemini vous permet d'enrichir automatiquement vos notes Markdown avec des métadonnées intelligentes générées par intelligence artificielle.
---
## 🚀 Démarrage
### Étape 1: Ouvrir le panneau IA
#### Sur Desktop
1. Localisez le bouton 🤖 dans la barre latérale gauche
2. Cliquez sur le bouton
3. Le panneau IA Gemini s'ouvre au centre de l'écran
#### Sur Mobile/Tablet
1. Ouvrez le menu latéral (☰)
2. Recherchez l'icône 🤖 "IA Gemini"
3. Appuyez pour ouvrir le panneau
### Étape 2: Sélectionner une note
1. Avant d'ouvrir le panneau, sélectionnez la note que vous voulez analyser
2. Le titre de la note apparaîtra dans la section "Note sélectionnée" du panneau
⚠️ **Important**: Si aucune note n'est sélectionnée, un avertissement s'affichera.
### Étape 3: Choisir une tâche
Le panneau affiche une grille de tâches disponibles. Actuellement disponible:
#### ✨ Résumé automatique (Actif)
**Description**: Génère une description courte (une ligne) et l'ajoute au frontmatter YAML de votre note.
**Utilisation**:
1. Cliquez sur la carte "Résumé automatique"
2. Une barre de progression s'affiche
3. Après ~1 seconde, un message de succès apparaît avec le résumé généré
4. Le champ `description:` est automatiquement ajouté au frontmatter YAML
**Exemple de résultat**:
```yaml
---
description: "Votre résumé généré automatiquement apparaît ici."
tags: []
---
```
#### 🏷️ Autres tâches (Beta - Non disponibles)
- **Tags intelligents**: Suggère des tags pertinents
- **Détection de type**: Identifie le type de note
- **Enrichir métadonnées**: Complète les champs manquants
- **Suggestions de liens**: Propose des liens connexes
- **Extraction mots-clés**: Identifie les concepts clés
Ces fonctionnalités seront disponibles dans les prochaines versions.
---
## 📝 Cas d'usage
### 1. Organisation du vault
**Problème**: Vous avez des centaines de notes sans descriptions claires.
**Solution**:
1. Parcourez vos notes une par une
2. Ouvrez le panneau IA Gemini
3. Exécutez "Résumé automatique" sur chaque note
4. Les descriptions facilitent la recherche et la navigation
### 2. Amélioration de la recherche
**Problème**: Vous ne retrouvez pas vos notes par leur titre.
**Solution**:
- Les résumés générés enrichissent le contenu indexé
- La recherche full-text trouve maintenant les notes via leurs descriptions
- Meilleure pertinence des résultats
### 3. Documentation de projet
**Problème**: Besoin de résumés pour une documentation.
**Solution**:
- Générez automatiquement les descriptions
- Exportez ou partagez les notes avec leurs métadonnées
- Gain de temps considérable
---
## 🎨 Interface utilisateur
### Header
```
┌─────────────────────────────────────────┐
│ 🤖 IA Gemini ✕ │
│ Assistant intelligent pour vos notes │
│ │
│ Note sélectionnée: Ma note │
└─────────────────────────────────────────┘
```
### Zone de statut (pendant l'exécution)
```
┌─────────────────────────────────────────┐
│ 🔄 Analyse en cours... │
│ ████████████░░░░░░░░░░ 60% │
└─────────────────────────────────────────┘
```
### Zone de statut (succès)
```
┌─────────────────────────────────────────┐
│ ✅ Résumé ajouté avec succès ! │
│ │
│ "Votre résumé généré apparaît ici." │
│ │
│ Complété en 850ms │
└─────────────────────────────────────────┘
```
### Zone de statut (erreur)
```
┌─────────────────────────────────────────┐
│ ❌ Erreur lors de l'exécution │
│ │
│ Aucun contenu textuel trouvé │
└─────────────────────────────────────────┘
```
### Grille de tâches
```
┌─────────────────────┬─────────────────────┐
│ ✨ Résumé auto │ 🏷️ Tags │
│ Génère une │ intelligents │
│ description │ [BETA] │
│ ─────────────── │ ─────────────── │
│ Actif ✓ │ Non disponible │
└─────────────────────┴─────────────────────┘
│ 🔍 Détection │ 📋 Enrichir │
│ de type │ métadonnées │
│ [BETA] │ [BETA] │
│ ─────────────── │ ─────────────── │
│ Non disponible │ Non disponible │
└─────────────────────┴─────────────────────┘
```
### Footer
```
┌─────────────────────────────────────────┐
│ 🟢 Service actif Tâches: 42 │
└─────────────────────────────────────────┘
```
---
## ⌨️ Raccourcis clavier
| Touche | Action |
|--------|--------|
| `ESC` | Fermer le panneau IA |
| `Click backdrop` | Fermer le panneau IA |
⚠️ **Note**: Vous ne pouvez pas fermer le panneau pendant qu'une tâche est en cours d'exécution.
---
## 🎨 Thèmes
Le panneau IA Gemini s'adapte automatiquement au thème sélectionné dans les paramètres:
### Mode clair (Light, Notion, GitHub)
- Fond blanc/crème
- Bordures subtiles
- Gradients pastels
### Mode sombre (Dark, Obsidian, Nord, Discord, Monokai)
- Fond sombre
- Bordures contrastées
- Gradients atténués
---
## 📱 Responsive
### Desktop (> 1024px)
- Panneau modal centré
- Largeur maximale: 2xl (~672px)
- Grille 2 colonnes pour les tâches
### Tablet (768px - 1024px)
- Panneau modal plein écran
- Padding réduit
- Grille 2 colonnes
### Mobile (< 768px)
- Panneau plein écran
- Padding minimal
- Grille 1 colonne (stacked)
- Boutons plus grands
---
## ❓ FAQ
### Q: Puis-je annuler une tâche en cours ?
**R**: Non, actuellement vous devez attendre la fin de l'exécution (~1 seconde). Une fonctionnalité d'annulation sera ajoutée dans une future version.
### Q: Que se passe-t-il si ma note est vide ?
**R**: Le service détectera qu'il n'y a pas de contenu textuel et affichera un message d'erreur approprié.
### Q: Le résumé écrase-t-il les autres champs YAML ?
**R**: Non, seul le champ `description` est ajouté/modifié. Tous les autres champs (tags, dates, etc.) sont préservés.
### Q: Puis-je modifier le résumé après génération ?
**R**: Oui, ouvrez le fichier `.md` dans l'éditeur et modifiez directement le champ `description:` dans le frontmatter YAML.
### Q: Le service fonctionne-t-il hors ligne ?
**R**: Oui, pour le MVP actuel (version 1.0), le résumé est généré localement sans appel externe. Les futures versions avec API Gemini nécessiteront une connexion internet.
### Q: Combien de temps prend la génération ?
**R**: Environ 1 seconde pour une note standard. Ce temps peut varier selon la longueur de la note.
### Q: Y a-t-il une limite de taille de note ?
**R**: Non, mais pour de très longues notes (> 10,000 mots), le temps de traitement peut augmenter.
### Q: Puis-je exécuter plusieurs tâches en parallèle ?
**R**: Non, une seule tâche peut s'exécuter à la fois. Vous devez attendre la fin de la première avant d'en lancer une autre.
### Q: Les tags beta seront disponibles quand ?
**R**: Les fonctionnalités beta sont prévues pour Q1-Q2 2025. Consultez la [ROADMAP](./README.md#roadmap) pour plus de détails.
---
## 🐛 Problèmes connus
### Le panneau ne s'ouvre pas
**Cause**: Conflit avec un autre panneau ouvert.
**Solution**: Fermez tous les autres panneaux (Parameters, About, etc.) et réessayez.
### Le résumé est trop court
**Cause**: La note contient principalement du code ou des listes.
**Solution**: L'algorithme actuel privilégie le texte naturel. Les futures versions amélioreront la détection de contenu pertinent.
### Le résumé ne reflète pas le contenu
**Cause**: Algorithme heuristique simple du MVP.
**Solution**: Version 1.1 avec API Gemini offrira des résumés plus précis et contextuels.
---
## 💡 Conseils d'utilisation
### 1. Préparez vos notes
- Assurez-vous que vos notes contiennent du texte naturel
- Les notes avec uniquement du code ou des listes ne généreront pas de bons résumés
### 2. Vérifiez le résultat
- Lisez toujours le résumé généré avant de l'accepter
- Vous pouvez le modifier manuellement si nécessaire
### 3. Utilisez en batch
- Pour traiter beaucoup de notes, gardez le panneau ouvert
- Naviguez entre les notes et exécutez la tâche rapidement
### 4. Personnalisez après coup
- Les résumés sont un point de départ
- Ajustez-les selon vos besoins spécifiques
---
## 📞 Support
### Besoin d'aide ?
- **Documentation**: [docs/GEMINI/](./GEMINI/)
- **Issues GitHub**: [ObsiViewer/issues](https://github.com/brunoCharest/ObsiViewer/issues)
- **Email**: support@obsiviewer.com
### Signaler un bug
1. Allez sur GitHub Issues
2. Créez un nouveau ticket
3. Incluez:
- Version d'ObsiViewer
- Description du problème
- Étapes pour reproduire
- Capture d'écran si possible
---
**Dernière mise à jour**: 2025-01-15
**Version**: 1.0.0
**Auteur**: Bruno Charest