refactor(docs): réorganiser la documentation selon principes DDD
Réorganise la documentation du projet selon les principes du Domain-Driven Design (DDD) pour améliorer la cohésion, la maintenabilité et l'alignement avec l'architecture modulaire du backend. **Structure cible:** ``` docs/domains/ ├── README.md (Context Map) ├── _shared/ (Core Domain) ├── recommendation/ (Supporting Subdomain) ├── content/ (Supporting Subdomain) ├── moderation/ (Supporting Subdomain) ├── advertising/ (Generic Subdomain) ├── premium/ (Generic Subdomain) └── monetization/ (Generic Subdomain) ``` **Changements effectués:** Phase 1: Création de l'arborescence des 7 bounded contexts Phase 2: Déplacement des règles métier (01-19) vers domains/*/rules/ Phase 3: Déplacement des diagrammes d'entités vers domains/*/entities/ Phase 4: Déplacement des diagrammes flux/états/séquences vers domains/*/ Phase 5: Création des README.md pour chaque domaine Phase 6: Déplacement des features Gherkin vers domains/*/features/ Phase 7: Création du Context Map (domains/README.md) Phase 8: Mise à jour de mkdocs.yml pour la nouvelle navigation Phase 9: Correction automatique des liens internes (script fix-markdown-links.sh) Phase 10: Nettoyage de l'ancienne structure (regles-metier/, diagrammes/, features/) **Configuration des tests:** - Makefile: godog run docs/domains/*/features/ - scripts/generate-bdd-docs.py: features_dir → docs/domains **Avantages:** ✅ Cohésion forte: toute la doc d'un domaine au même endroit ✅ Couplage faible: domaines indépendants, dépendances explicites ✅ Navigabilité améliorée: README par domaine = entrée claire ✅ Alignement code/docs: miroir de backend/internal/ ✅ Onboarding facilité: exploration domaine par domaine ✅ Tests BDD intégrés: features au plus près des règles métier Voir docs/REFACTOR-DDD.md pour le plan complet.
This commit is contained in:
141
scripts/fix-markdown-links.sh
Executable file
141
scripts/fix-markdown-links.sh
Executable file
@@ -0,0 +1,141 @@
|
||||
#!/bin/bash
|
||||
# Script pour corriger les liens internes dans la documentation après refactorisation DDD
|
||||
|
||||
set -e
|
||||
|
||||
echo "🔗 Correction des liens internes dans la documentation..."
|
||||
|
||||
# Fonction pour corriger les liens dans les fichiers du domaine _shared
|
||||
fix_shared_links() {
|
||||
echo " → Correction des liens dans _shared..."
|
||||
find docs/domains/_shared -type f -name "*.md" -exec sed -i \
|
||||
-e 's|../../regles-metier/01-authentification-inscription.md|../rules/authentification.md|g' \
|
||||
-e 's|../../regles-metier/02-conformite-rgpd.md|../rules/rgpd.md|g' \
|
||||
-e 's|../../regles-metier/10-gestion-erreurs.md|../rules/gestion-erreurs.md|g' \
|
||||
-e 's|modele-global.md|../entities/modele-global.md|g' \
|
||||
{} \;
|
||||
}
|
||||
|
||||
# Fonction pour corriger les liens dans les fichiers du domaine recommendation
|
||||
fix_recommendation_links() {
|
||||
echo " → Correction des liens dans recommendation..."
|
||||
find docs/domains/recommendation -type f -name "*.md" -exec sed -i \
|
||||
-e 's|../../regles-metier/03-centres-interet-jauges.md|../rules/centres-interet-jauges.md|g' \
|
||||
-e 's|../../regles-metier/04-algorithme-recommandation.md|../rules/algorithme-recommandation.md|g' \
|
||||
-e 's|../../regles-metier/05-interactions-navigation.md|../rules/interactions-navigation.md|g' \
|
||||
-e 's|../../docs/regles-metier/04-algorithme-recommandation.md|../rules/algorithme-recommandation.md|g' \
|
||||
-e 's|modele-global.md|../../_shared/entities/modele-global.md|g' \
|
||||
{} \;
|
||||
}
|
||||
|
||||
# Fonction pour corriger les liens dans les fichiers du domaine content
|
||||
fix_content_links() {
|
||||
echo " → Correction des liens dans content..."
|
||||
find docs/domains/content -type f -name "*.md" -exec sed -i \
|
||||
-e 's|../../regles-metier/06-audio-guides-multi-sequences.md|../rules/audio-guides.md|g' \
|
||||
-e 's|../../regles-metier/07-contenus-geolocalises-voiture.md|../rules/contenus-geolocalises.md|g' \
|
||||
-e 's|../../regles-metier/11-creation-publication-contenu.md|../rules/creation-publication.md|g' \
|
||||
-e 's|../../regles-metier/12-radio-live.md|../rules/radio-live.md|g' \
|
||||
-e 's|../../regles-metier/13-detection-contenu-protege.md|../rules/detection-contenu-protege.md|g' \
|
||||
-e 's|modele-global.md|../../_shared/entities/modele-global.md|g' \
|
||||
{} \;
|
||||
}
|
||||
|
||||
# Fonction pour corriger les liens dans les fichiers du domaine advertising
|
||||
fix_advertising_links() {
|
||||
echo " → Correction des liens dans advertising..."
|
||||
find docs/domains/advertising -type f -name "*.md" -exec sed -i \
|
||||
-e 's|../../regles-metier/16-publicites.md|../rules/publicites.md|g' \
|
||||
-e 's|modele-global.md|../../_shared/entities/modele-global.md|g' \
|
||||
{} \;
|
||||
}
|
||||
|
||||
# Fonction pour corriger les liens dans les fichiers du domaine premium
|
||||
fix_premium_links() {
|
||||
echo " → Correction des liens dans premium..."
|
||||
find docs/domains/premium -type f -name "*.md" -exec sed -i \
|
||||
-e 's|../../regles-metier/08-mode-offline.md|../rules/mode-offline.md|g' \
|
||||
-e 's|../../regles-metier/09-abonnements-notifications.md|../rules/abonnements-notifications.md|g' \
|
||||
-e 's|../../regles-metier/17-premium.md|../rules/premium.md|g' \
|
||||
-e 's|modele-global.md|../../_shared/entities/modele-global.md|g' \
|
||||
{} \;
|
||||
}
|
||||
|
||||
# Fonction pour corriger les liens dans les fichiers du domaine monetization
|
||||
fix_monetization_links() {
|
||||
echo " → Correction des liens dans monetization..."
|
||||
find docs/domains/monetization -type f -name "*.md" -exec sed -i \
|
||||
-e 's|../../regles-metier/18-monetisation-createurs.md|../rules/monetisation-createurs.md|g' \
|
||||
-e 's|modele-global.md|../../_shared/entities/modele-global.md|g' \
|
||||
{} \;
|
||||
}
|
||||
|
||||
# Fonction pour corriger les liens dans les fichiers du domaine moderation
|
||||
fix_moderation_links() {
|
||||
echo " → Correction des liens dans moderation..."
|
||||
find docs/domains/moderation -type f -name "*.md" -exec sed -i \
|
||||
-e 's|../../regles-metier/14-moderation-flows.md|../rules/moderation-flows.md|g' \
|
||||
-e 's|../../regles-metier/15-moderation-communautaire.md|../rules/moderation-communautaire.md|g' \
|
||||
-e 's|../../regles-metier/19-autres-comportements.md|../rules/autres-comportements.md|g' \
|
||||
-e 's|modele-global.md|../../_shared/entities/modele-global.md|g' \
|
||||
{} \;
|
||||
}
|
||||
|
||||
# Fonction pour corriger les liens dans les autres fichiers docs (ADR, etc.)
|
||||
fix_other_docs_links() {
|
||||
echo " → Correction des liens dans ADR et autres docs..."
|
||||
|
||||
# ADR et autres fichiers qui référencent les anciennes règles métier
|
||||
find docs/adr docs/mobile docs/compliance docs/architecture -type f -name "*.md" 2>/dev/null -exec sed -i \
|
||||
-e 's|regles-metier/01-authentification-inscription.md|domains/_shared/rules/authentification.md|g' \
|
||||
-e 's|regles-metier/02-conformite-rgpd.md|domains/_shared/rules/rgpd.md|g' \
|
||||
-e 's|regles-metier/03-centres-interet-jauges.md|domains/recommendation/rules/centres-interet-jauges.md|g' \
|
||||
-e 's|regles-metier/04-algorithme-recommandation.md|domains/recommendation/rules/algorithme-recommandation.md|g' \
|
||||
-e 's|regles-metier/05-interactions-navigation.md|domains/recommendation/rules/interactions-navigation.md|g' \
|
||||
-e 's|regles-metier/06-audio-guides-multi-sequences.md|domains/content/rules/audio-guides.md|g' \
|
||||
-e 's|regles-metier/07-contenus-geolocalises-voiture.md|domains/content/rules/contenus-geolocalises.md|g' \
|
||||
-e 's|regles-metier/08-mode-offline.md|domains/premium/rules/mode-offline.md|g' \
|
||||
-e 's|regles-metier/09-abonnements-notifications.md|domains/premium/rules/abonnements-notifications.md|g' \
|
||||
-e 's|regles-metier/10-gestion-erreurs.md|domains/_shared/rules/gestion-erreurs.md|g' \
|
||||
-e 's|regles-metier/11-creation-publication-contenu.md|domains/content/rules/creation-publication.md|g' \
|
||||
-e 's|regles-metier/12-radio-live.md|domains/content/rules/radio-live.md|g' \
|
||||
-e 's|regles-metier/13-detection-contenu-protege.md|domains/content/rules/detection-contenu-protege.md|g' \
|
||||
-e 's|regles-metier/14-moderation-flows.md|domains/moderation/rules/moderation-flows.md|g' \
|
||||
-e 's|regles-metier/15-moderation-communautaire.md|domains/moderation/rules/moderation-communautaire.md|g' \
|
||||
-e 's|regles-metier/16-publicites.md|domains/advertising/rules/publicites.md|g' \
|
||||
-e 's|regles-metier/17-premium.md|domains/premium/rules/premium.md|g' \
|
||||
-e 's|regles-metier/18-monetisation-createurs.md|domains/monetization/rules/monetisation-createurs.md|g' \
|
||||
-e 's|regles-metier/19-autres-comportements.md|domains/moderation/rules/autres-comportements.md|g' \
|
||||
-e 's|diagrammes/entites/modele-global.md|domains/_shared/entities/modele-global.md|g' \
|
||||
-e 's|diagrammes/entites/modele-recommandation.md|domains/recommendation/entities/modele-recommandation.md|g' \
|
||||
-e 's|diagrammes/entites/modele-audio-guides.md|domains/content/entities/modele-audio-guides.md|g' \
|
||||
-e 's|diagrammes/entites/modele-radio-live.md|domains/content/entities/modele-radio-live.md|g' \
|
||||
-e 's|diagrammes/entites/modele-publicites.md|domains/advertising/entities/modele-publicites.md|g' \
|
||||
-e 's|diagrammes/entites/modele-premium.md|domains/premium/entities/modele-premium.md|g' \
|
||||
-e 's|diagrammes/entites/modele-monetisation.md|domains/monetization/entities/modele-monetisation.md|g' \
|
||||
-e 's|diagrammes/entites/modele-moderation.md|domains/moderation/entities/modele-moderation.md|g' \
|
||||
-e 's|diagrammes/flux/moderation-signalement.md|domains/moderation/flows/moderation-signalement.md|g' \
|
||||
-e 's|diagrammes/etats/signalement-lifecycle.md|domains/moderation/states/signalement-lifecycle.md|g' \
|
||||
-e 's|diagrammes/sequence/processus-appel-moderation.md|domains/moderation/sequences/processus-appel-moderation.md|g' \
|
||||
{} \; 2>/dev/null || true
|
||||
|
||||
# Fichier gherkin-moderation-overview.md
|
||||
if [ -f docs/gherkin-moderation-overview.md ]; then
|
||||
sed -i \
|
||||
-e 's|regles-metier/14-moderation-flows.md|domains/moderation/rules/moderation-flows.md|g' \
|
||||
-e 's|regles-metier/15-moderation-communautaire.md|domains/moderation/rules/moderation-communautaire.md|g' \
|
||||
docs/gherkin-moderation-overview.md
|
||||
fi
|
||||
}
|
||||
|
||||
# Exécuter toutes les corrections
|
||||
fix_shared_links
|
||||
fix_recommendation_links
|
||||
fix_content_links
|
||||
fix_advertising_links
|
||||
fix_premium_links
|
||||
fix_monetization_links
|
||||
fix_moderation_links
|
||||
fix_other_docs_links
|
||||
|
||||
echo "✅ Correction des liens terminée!"
|
||||
Reference in New Issue
Block a user