30 lines
1.5 KiB
Markdown
30 lines
1.5 KiB
Markdown
# 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](../README.md)
|
|
- **Je veux comprendre les frontières et dépendances** → [ARCHITECTURE.md](ARCHITECTURE.md)
|
|
- **Je veux connaître les conventions de module** → [MODULES.md](MODULES.md)
|
|
- **Je veux savoir ce qui est public ou interne** → [PUBLIC_API.md](PUBLIC_API.md)
|
|
- **Je travaille au quotidien sur le dépôt** → [DEVELOPMENT.md](DEVELOPMENT.md)
|
|
- **Je contribue au dépôt** → [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
|
|
|
## Si tu ne lis que trois documents
|
|
|
|
1. [../README.md](../README.md) pour comprendre ce que contient le dépôt
|
|
2. [ARCHITECTURE.md](ARCHITECTURE.md) avant toute évolution structurelle
|
|
3. [PUBLIC_API.md](PUBLIC_API.md) avant d'utiliser le core comme dépendance applicative
|
|
|
|
## Rôle de chaque document
|
|
|
|
| Document | Rôle |
|
|
|---|---|
|
|
| [../README.md](../README.md) | Vue d'ensemble et mode d'installation du socle |
|
|
| [ARCHITECTURE.md](ARCHITECTURE.md) | Référence sur les modules, les couches et les dépendances autorisées |
|
|
| [MODULES.md](MODULES.md) | Charte de module et conventions de frontière |
|
|
| [PUBLIC_API.md](PUBLIC_API.md) | Délimitation de l'API publique et de l'API interne |
|
|
| [DEVELOPMENT.md](DEVELOPMENT.md) | Guide de travail quotidien, variables d'environnement et checklist avant push |
|
|
| [../CONTRIBUTING.md](../CONTRIBUTING.md) | Règles de contribution et attentes sur les tests |
|