ComposantsExpériences visuelles

Expériences visuelles

Règles pour enrichir Orbit sans casser le design system natif de Documentation.AI.

Principe : native first

Documentation.AI reste le design system principal.

Orbit ne recrée pas :

  • le layout ;
  • les cards ;
  • les headings ;
  • la navigation ;
  • le système de thème ;
  • les composants de base.

Le Custom CSS et les éventuels Custom Scripts servent uniquement de surcouche ciblée.

Ce que nous personnalisons

ÉlémentRègle
Headers de tableauxNoir pur pour créer un contraste clair dans les listes
Dark modeLe moteur natif reste actif ; les grandes surfaces utilisent #000 plutôt qu’un gris foncé
Frames de featuresPonctuelles, uniquement pour une vraie démo ou un élément important
MermaidArchitecture, séquences et relations
BoardRoadmap et états de delivery
Iframe / VideoDémonstrations réelles quand la ressource a le même niveau d’accès

Ce que nous évitons

  • gros hero custom dans une page de documentation ;
  • cartes recréées autour des headings ;
  • animations décoratives ;
  • CSS qui redessine l’intégralité du template ;
  • JavaScript qui force le thème du lecteur ;
  • visualisation simplement « jolie » sans valeur explicative.

Motions

Une motion est acceptable seulement si elle représente une transition produit réelle :

  • encodage ;
  • compression ;
  • passage d’un état à un autre ;
  • progression d’un workflow.

Dans tous les autres cas, utiliser le composant natif le plus simple.

Frames

Une vraie feature interactive peut être intégrée avec <Iframe> ou <Video>.

Pour une ressource privée, la cible embarquée possède sa propre authentification serveur. L’ACL de la page Documentation.AI ne protège pas automatiquement une URL externe.