Documentation
Trouver la bonne page
La documentation vit avec le code, sur GitHub : elle correspond toujours à la version publiée. Partez de ce que vous voulez faire.
Les guides sont en anglais, sauf le guide d’utilisation complet, qui est en français.
Installer et exploiter
- Installer avec Docker Installer, se connecter, brancher un modèle et traduire un premier livre. Accès réseau et HTTPS, mises à jour, désinstallation, dépannage. docs/docker.md
- Référence de configuration Toutes les variables d’environnement, des budgets de coût à la file équitable et au mode d’analyse, et les réglages modifiables dans l’interface. docs/configuration.md
- Exploitation Mettre à jour, surveiller, maîtriser les coûts, lire les journaux et dépanner une installation. docs/operations.md
- Sauvegarde et restauration Sauvegarder la base et les livres, et vérifier qu’une sauvegarde se restaure. docs/backup.md
- Codex et ChatGPT Traduire avec les modèles Codex, par clé d’API ou avec un compte ChatGPT. docs/codex.md
- OpenViking Ajouter OpenViking comme mémoire externe pour vos livres et vos séries, et la nettoyer quand ils sont supprimés. docs/openviking.md
Utiliser Libris
- Guide d’utilisation Toute l’interface, de la bibliothèque aux exports : séries, carte des chapitres, qualité, budgets, glossaires partagés, file d’attente et jetons d’API. docs/user-guide.fr.md
- Le pilote automatique Ce qui se passe entre l’import et le livre fini, la gestion des échecs, et comment le désactiver. docs/autopilot.md
- API d’automatisation Envoyer des livres ou de nouveaux chapitres depuis un script et récupérer la traduction. docs/api.md
- Description OpenAPI Le contrat de l’API d’automatisation en OpenAPI 3.1, pour les outils OpenAPI et les générateurs de clients. docs/openapi/libris-v1.json
- Client d’exemple Un client Python qui n’utilise que la bibliothèque standard : envoyer, attendre, télécharger et recevoir les webhooks. examples/libris_client.py
Comprendre et contribuer
- Architecture Composants, parcours d’un livre, analyse parallèle, file équitable, scores de qualité, modèle de données et conception de la sécurité. docs/architecture.md
- Développement Environnement de développement, tests, intégration continue et publication. docs/development.md
- Système de design Jetons et composants pour des écrans cohérents avec le reste de Libris. docs/design-system.md
- Contribuer Comment proposer une modification. CONTRIBUTING.md