Skip to content

docs(readme): #4 rédiger README.md et scripts/README.md

Mathéo ALLARD requested to merge docs/4-readme-scripts-readme into main

Résumé

  • README.md : vue d'ensemble du repo (principe submodule, démarrage rapide, structure guidelines/, renvoi vers scripts/README.md et docs/audit-dependances.md, validation, licence).
  • scripts/README.md : documentation technique de install-guidelines.js (usage, flags, format techs.yaml, pipeline des 18 steps, mécanisme {{step: name}}, sorties par outil cible, migration des points d'entrée existants, fichiers générés vs commités, .guidelines.lock).

Rédaction pure, aucun changement de code. Basé sur une relecture complète de scripts/install-guidelines.js, scripts/steps/*.js et scripts/lib/*.js.

Closes #4 (closed)

Vérifications

  • node scripts/check-structure.js — 9/9 règles OK
  • npm run lint — OK
  • npm test — 236/236 tests OK

Merge request reports

Loading