Documentation
Ce dossier contient les documents de référence du socle netslim-core.
Par où commencer ?
- Je découvre le dépôt → ../README.md
- Je veux comprendre les frontières et dépendances → ARCHITECTURE.md
- Je veux connaître les conventions de module → MODULES.md
- Je veux savoir ce qui est public ou interne → PUBLIC_API.md
- Je travaille au quotidien sur le dépôt → DEVELOPMENT.md
- Je contribue au dépôt → ../CONTRIBUTING.md
Si tu ne lis que trois documents
- ../README.md pour comprendre ce que contient le dépôt
- ARCHITECTURE.md avant toute évolution structurelle
- PUBLIC_API.md avant d'utiliser le core comme dépendance applicative
Rôle de chaque document
| Document | Rôle |
|---|---|
| ../README.md | Vue d'ensemble et mode d'installation du socle |
| ARCHITECTURE.md | Référence sur les modules, les couches et les dépendances autorisées |
| MODULES.md | Charte de module et conventions de frontière |
| PUBLIC_API.md | Délimitation de l'API publique et de l'API interne |
| DEVELOPMENT.md | Guide de travail quotidien, variables d'environnement et checklist avant push |
| ../CONTRIBUTING.md | Règles de contribution et attentes sur les tests |