Skip to main content

Documentation Vivante

Documentation mise à jour automatiquement à partir des spécifications Gauge et du code source.

Spécifications Testées

Chaque comportement documenté est associé à des tests automatiques garantissant sa validité.

Architecture Détaillée

Diagrammes et explications pour comprendre le fonctionnement interne de l’application.

Guides Pratiques

Exemples concrets d’utilisation pour vous aider à maîtriser rapidement l’application.

À propos de Remora

Remora est une application de trading automatisé qui permet de :
  • Gérer des positions sur différents échanges cryptographiques
  • Créer et suivre des stratégies de trading
  • Automatiser les entrées et sorties de marché
  • Visualiser les performances des positions

Structure de la Documentation

Cette documentation est organisée en plusieurs sections :
  • Guides : Instructions pas à pas pour utiliser l’application
  • Architecture : Description technique de l’organisation du code
  • Spécifications : Comportements fonctionnels documentés et testés
  • API : Documentation technique des interfaces de programmation

Documentation vivante

Cette documentation est générée automatiquement à partir de :
  1. Spécifications Gauge (comportements testés)
  2. Annotations TSDoc/JSDoc dans le code source
  3. Diagrammes d’architecture maintenus à jour
L’ensemble est publié automatiquement à chaque mise à jour validée du code.