3.1 KiB
3.1 KiB
📚 Guides d'utilisation ObsiGate
Bienvenue dans le répertoire des guides utilisateur d'ObsiGate. Chaque guide est autonome, écrit en français et illustré d'exemples concrets (commandes, configuration, captures conceptuelles).
Vous découvrez ObsiGate ? Commencez par le Guide de prise en main. Une aide rapide est aussi intégrée directement dans l'application (menu Options → Guide d'utilisation, FR/EN, téléchargeable en Markdown et PDF).
🗂️ Sommaire des guides
| Guide | Public | Contenu |
|---|---|---|
| 🚀 Prise en main | Tous | Premier lancement, interface, navigation, vaults, raccourcis |
| 🔍 Recherche, PDF & Excalidraw | Tous | Syntaxe de requête, recherche sémantique, lecteur PDF, diagrammes |
| 🤖 Assistant IA & Forge | Tous | Fournisseurs, éditeur IA, BooksLM, Forge, commandes @ / / |
| 📝 Édition & collaboration | Tous | Édition simultanée, curseurs distants, persistance |
| 📱 PWA & mode hors-ligne | Tous | Installation PWA, cache, file de synchronisation, notifications |
| 🔌 API REST | Développeurs | Authentification, clés API, endpoints, exemples curl, SSE |
| 🧩 Serveur MCP | Développeurs / IA | Brancher Claude Desktop, Cursor, Cline… sur vos vaults |
| 🔒 Authentification & sécurité | Admin | Utilisateurs, MFA, permissions par vault, bonnes pratiques |
| 🐳 Déploiement Docker | Admin / Ops | docker-compose, volumes, reverse proxy, mises à jour |
| 🖥️ Application desktop (Tauri) | Tous | Installation, premier lancement, build depuis les sources |
🧭 Par où commencer ?
- Je veux juste utiliser l'application → Prise en main
- Je veux sécuriser mon instance → Authentification & sécurité
- Je veux brancher une IA → Assistant IA & Forge puis MCP
- Je veux scripter/automatiser → API REST
- Je veux héberger sur un serveur → Déploiement Docker
📖 Documentation associée
| Type | Où |
|---|---|
| Vue d'ensemble produit | README.fr.md · README.md |
| Conception détaillée par fonctionnalité | docs/features/ |
| Standards de code | docs/CONTRIBUTING.md |
| Méthode de livraison (Definition of Done) | docs/DELIVERY_WORKFLOW.md |
| Roadmap / travail à venir | docs/ROADMAP.md |
| Historique des versions | CHANGELOG.md |
| API interactive (Swagger / ReDoc) | /docs · /redoc (instance ObsiGate) |
Convention : ce répertoire est la porte d'entrée utilisateur. Le comment (utilisation) vit ici ; le pourquoi (conception technique) vit dans
docs/features/. Ne jamais dupliquer le détail technique des fiches.