Livrer la documentation avec le code source

Livrer la documentation sous forme texte à côté du code est vraiment très pratique pour vos utilisateurs, merci d'y penser 😊

Je m'explique: pour un ancien projet, je dois utiliser une vielle version de composer, un outil de gestion de dépendances pour les projets PHP.

Comme j'ai eu besoin de toucher aux dépendances du projet, je devais retrouver les bonnes options de composer v1.

Seulement, la documentation en ligne de composer donne les informations pour la dernière version publiée (v2.x).

Heureusement le code source de composer contient aussi la documentation. Il m'a donc suffit de télécharger la release de la version nécessaire et de parcourir le dossier docs de composer pour retrouver les bonnes options disponibles.

Ce dossier contient des fichiers textes, je n'ai donc même pas eu besoin de démarrer un serveur web pour visualiser la documentation.

Commentaires

Vous pouvez ajouter un commentaire avec votre compte Fediverse sur ce message.