bySince
DOCUMENTATION

Captures automatisées de la documentation

Ce dossier contient (à terme) les scripts d'automatisation Playwright qui régénèrent les captures d'écran intégrées dans les fichiers Markdown du dossier parent et déposées dans ../DOC_HTML/image/.

Mise en route

1. Installer les MCP Claude Code (une fois pour toutes)

# MCP Playwright — pilotage navigateur, captures stables
claude mcp add playwright -- npx -y @playwright/mcp@latest

# MCP Chrome DevTools — profilage, réseau, debug sur Chrome ouvert
claude mcp add chrome-devtools -- npx -y chrome-devtools-mcp@latest

# Vérifier
claude mcp list

2. Préparer le .env

cp .env.example .env
# puis éditer .env et renseigner les credentials

Le .env est gitignoré — il ne doit pas être commité.

3. Préparer un jeu de données stable sur l'environnement de test

Pour que les captures soient identiques d'une exécution à l'autre, prévoir sur test.sincedigital.fr :

  • un utilisateur admin dédié (ex. doc-bot@sincedigital.fr) — pour les écrans admin
  • un parcours séquentiel pré-rempli (titre stable, activités stables, inscriptions stables)
  • un parcours Exploration pré-rempli
  • au moins un bilan dans chacun des 4 états :
    • created (programmé, en attente d'auto-évaluation)
    • self_evaluated (auto-évaluation reçue)
    • in_preparation (préparation tuteur enregistrée)
    • completed (bilan finalisé avec PDF)
  • optionnellement, un utilisateur apprenant dédié et un utilisateur tuteur dédié pour capturer leurs écrans respectifs

4. Lancer la régénération des captures

À venir : un script capture-all.sh qui lance tous les .spec.js et dépose les images dans ../DOC_HTML/image/.

Convention de nommage des captures

Pour qu'une capture soit identifiée et automatiquement remplaçable, son nom de fichier suit le pattern :

<doc>-<étape>-<description>.png

Exemples :

  • bilan-apprenant-step2-form.png
  • bilan-tuteur-dashboard-bandeaux.png
  • parcours-exploration-step3-type-selector.png

Les noms doivent correspondre exactement aux références <img src="image/..."> dans les fichiers .md du dossier parent.

Sécurité

  • Ne jamais coller les credentials en chat avec Claude. Toujours passer par le .env.
  • Le .env, .auth/ (sessions Playwright sauvegardées), node_modules/ et test-results/ sont gitignorés.
  • En cas de compromission du compte doc-bot, le mot de passe doit être révoqué côté serveur.