Documentation

Politique docs

Synchronisation entre README, Zola, TypeDoc et AGENTS.md.

La documentation est distribuee par audience.

  • Les README packages sont la source package pour consommateurs npm/GitLab.
  • Les pages Zola sont le site public et la couche narrative.
  • TypeDoc est la reference generee par symbole.
  • AGENTS.md guide les contributeurs et agents dans le repository.

Regles minimales:

  • changement d’API package -> README package et page Zola pertinente;
  • changement d’onboarding repo -> README racine et pages Start;
  • guide nouveau ou deplace -> navigation Zola et liens de reference;
  • responsabilites package modifiees -> AGENTS.md et carte des packages.