TraDoc Docs
Développeurs

Maintenir la documentation

Garder les pages alignées avec le produit et valider le site documentaire.

La documentation est un dépôt séparé du produit. Elle ne doit pas deviner l'état d'une fonction à partir de la landing page ou de la démo.

Sources prioritaires

  1. Code et tests de projets/tradoc.
  2. Sortie actuelle des commandes --help.
  3. Fichiers .env.example, Dockerfile et Compose.
  4. Interface du produit.
  5. README, après vérification contre le code.

Validation

npm run check:content
npm run check:links
npm run lint
npm run typecheck
npm run build

Lors d'une évolution

  • Nouveau fournisseur : mettre à jour fournisseurs et tests de connexion.
  • Nouveau format : documenter extraction, aperçu, reconstruction et type MIME.
  • Nouvelle variable : ajouter défaut, limites et conséquences de sécurité.
  • Nouvelle commande : exécuter --help avant de publier sa syntaxe.
  • Nouveau domaine : ne le présenter comme actif qu'après un contrôle HTTPS réel.

Markdown pour assistants

Chaque page fournit une version Markdown traitée via le menu de page. Elle est générée depuis le même MDX afin d'éviter une seconde documentation divergente.

On this page