38 lines
2.1 KiB
Markdown
38 lines
2.1 KiB
Markdown
# Documentation
|
||
|
||
> Cette application nécessite une version récente de `netig/netslim-core` exposant les modules `Settings`, `AuditLog`, `Notifications` et l'authorization fine d'`Identity`. En cas d'erreur sur `SettingsModule` ou `SettingsReaderInterface`, mets d'abord à jour le dépôt du core puis relance `composer update netig/netslim-core`.
|
||
|
||
Ce dossier rassemble les documents utiles pour travailler sur `netslim-blog`.
|
||
|
||
## Par où commencer ?
|
||
|
||
- **Je découvre le projet** → [../README.md](../README.md)
|
||
- **Je dois comprendre vite comment il est organisé** → [ONBOARDING.md](ONBOARDING.md)
|
||
- **Je veux comprendre l'application livrée** → [APPLICATION.md](APPLICATION.md)
|
||
- **Je veux comprendre le rôle du core et du code local** → [ARCHITECTURE.md](ARCHITECTURE.md)
|
||
- **Je travaille au quotidien sur le dépôt** → [DEVELOPMENT.md](DEVELOPMENT.md)
|
||
- **Je touche à Twig, SCSS ou JavaScript d’écran** → [FRONTEND.md](FRONTEND.md)
|
||
- **Je prépare un déploiement Docker** → [DEPLOYMENT.md](DEPLOYMENT.md)
|
||
- **Je veux connaître les garde-fous de long terme** → [MAINTENANCE.md](MAINTENANCE.md)
|
||
- **Je contribue au dépôt** → [../CONTRIBUTING.md](../CONTRIBUTING.md)
|
||
|
||
## Si tu ne lis que trois documents
|
||
|
||
1. [../README.md](../README.md)
|
||
2. [ONBOARDING.md](ONBOARDING.md)
|
||
3. [ARCHITECTURE.md](ARCHITECTURE.md)
|
||
|
||
## Rôle de chaque document
|
||
|
||
| Document | Rôle |
|
||
|---|---|
|
||
| [../README.md](../README.md) | Vue d'ensemble, démarrage rapide, modules activés |
|
||
| [ONBOARDING.md](ONBOARDING.md) | Parcours de découverte du dépôt |
|
||
| [ARCHITECTURE.md](ARCHITECTURE.md) | Frontière entre le blog et `netslim-core` |
|
||
| [APPLICATION.md](APPLICATION.md) | Vue d'ensemble de l'application blog livrée |
|
||
| [DEVELOPMENT.md](DEVELOPMENT.md) | Guide de travail quotidien et checklist avant push |
|
||
| [FRONTEND.md](FRONTEND.md) | Référence Twig, SCSS, JavaScript d'écran |
|
||
| [DEPLOYMENT.md](DEPLOYMENT.md) | Déploiement Docker et répertoires persistants |
|
||
| [MAINTENANCE.md](MAINTENANCE.md) | Garde-fous pour faire évoluer le dépôt sans le dégrader |
|
||
| [../CONTRIBUTING.md](../CONTRIBUTING.md) | Règles de contribution |
|