Structure minimaliste : - docs/diagrammes/flux/ : Flowcharts - docs/diagrammes/etats/ : State diagrams - docs/diagrammes/sequence/ : Sequence diagrams - docs/diagrammes/entites/ : Entity-Relationship diagrams Exemples créés pour modération (Section 14) : - Flux de signalement complet - Cycle de vie d'un signalement (13 états) - Processus d'appel créateur - Modèle de données modération (8 entités) Chaque fichier contient uniquement : - Référence vers règle métier - Diagramme Mermaid détaillé - Légende courte Intégration dans navigation MkDocs.
155 lines
6.4 KiB
YAML
155 lines
6.4 KiB
YAML
site_name: RoadWave Documentation
|
|
site_description: Documentation complète du projet RoadWave - Réseau social audio géolocalisé
|
|
site_author: RoadWave Team
|
|
|
|
theme:
|
|
name: material
|
|
language: fr
|
|
palette:
|
|
# Light mode
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Passer en mode sombre
|
|
# Dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Passer en mode clair
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.top
|
|
- navigation.tracking
|
|
- search.suggest
|
|
- search.highlight
|
|
- content.code.copy
|
|
- toc.follow
|
|
|
|
plugins:
|
|
- search:
|
|
lang: fr
|
|
- glightbox: # Lightbox pour agrandir les images
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- pymdownx.details
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
- attr_list
|
|
- md_in_html # Permet d'utiliser du markdown dans du HTML
|
|
- def_list
|
|
|
|
nav:
|
|
- Accueil: index.md
|
|
- Architecture Technique: technical.md
|
|
- Architecture Decision Records (ADR):
|
|
- 'ADR-001: Langage Backend': adr/001-langage-backend.md
|
|
- 'ADR-002: Protocole Streaming': adr/002-protocole-streaming.md
|
|
- 'ADR-003: Codec Audio': adr/003-codec-audio.md
|
|
- 'ADR-004: CDN': adr/004-cdn.md
|
|
- 'ADR-005: Base de données': adr/005-base-de-donnees.md
|
|
- 'ADR-006: Chiffrement': adr/006-chiffrement.md
|
|
- 'ADR-007: Tests BDD': adr/007-tests-bdd.md
|
|
- 'ADR-008: Authentification': adr/008-authentification.md
|
|
- 'ADR-009: Solution Paiement': adr/009-solution-paiement.md
|
|
- 'ADR-010: Architecture Backend': adr/010-architecture-backend.md
|
|
- 'ADR-011: ORM et Accès Données': adr/011-orm-acces-donnees.md
|
|
- 'ADR-012: Frontend Mobile': adr/012-frontend-mobile.md
|
|
- 'ADR-013: Stratégie Tests': adr/013-strategie-tests.md
|
|
- 'ADR-014: Organisation en Monorepo': adr/014-organisation-monorepo.md
|
|
- 'ADR-015: Hébergement': adr/015-hebergement.md
|
|
- 'ADR-016: Service Emailing': adr/016-service-emailing.md
|
|
- 'ADR-017: Notifications Géolocalisées': adr/017-notifications-geolocalisees.md
|
|
- 'ADR-018: Librairies Go': adr/018-librairies-go.md
|
|
- 'ADR-019: Géolocalisation par IP': adr/019-geolocalisation-ip.md
|
|
- 'ADR-020: Librairies Flutter': adr/020-librairies-flutter.md
|
|
- 'ADR-021: Solution de Cache': adr/021-solution-cache.md
|
|
- 'ADR-022: CI/CD Monorepo': adr/022-strategie-cicd-monorepo.md
|
|
- 'ADR-023: Architecture Modération': adr/023-architecture-moderation.md
|
|
- 'ADR-024: Monitoring & Observabilité': adr/024-monitoring-observabilite.md
|
|
- 'ADR-025: Sécurité & Secrets': adr/025-securite-secrets.md
|
|
- Règles Métier:
|
|
- Introduction: regles-metier/README.md
|
|
- Fondations & Compte:
|
|
- '01: Authentification': regles-metier/01-authentification-inscription.md
|
|
- '02: Conformité RGPD': regles-metier/02-conformite-rgpd.md
|
|
- Consommation de contenu:
|
|
- '03: Centres Intérêt': regles-metier/03-centres-interet-jauges.md
|
|
- '04: Algorithme Recommandation': regles-metier/04-algorithme-recommandation.md
|
|
- '05: Interactions Navigation': regles-metier/05-interactions-navigation.md
|
|
- '06: Audio-guides': regles-metier/06-audio-guides-multi-sequences.md
|
|
- '07: Contenus Voiture': regles-metier/07-contenus-geolocalises-voiture.md
|
|
- '08: Mode Offline': regles-metier/08-mode-offline.md
|
|
- '09: Abonnements': regles-metier/09-abonnements-notifications.md
|
|
- '10: Gestion Erreurs': regles-metier/10-gestion-erreurs.md
|
|
- Création de contenu:
|
|
- '11: Création Contenu': regles-metier/11-creation-publication-contenu.md
|
|
- '12: Radio Live': regles-metier/12-radio-live.md
|
|
- '13: Contenu Protégé': regles-metier/13-detection-contenu-protege.md
|
|
- Modération & Sécurité:
|
|
- '14: Modération': regles-metier/14-moderation-flows.md
|
|
- '15: Modération Communautaire': regles-metier/15-moderation-communautaire.md
|
|
- Monétisation & Business:
|
|
- '16: Publicités': regles-metier/16-publicites.md
|
|
- '17: Premium': regles-metier/17-premium.md
|
|
- '18: Monétisation Créateurs': regles-metier/18-monetisation-createurs.md
|
|
- Transverse:
|
|
- '19: Autres Comportements': regles-metier/19-autres-comportements.md
|
|
- 'Annexe: Post-MVP': regles-metier/ANNEXE-POST-MVP.md
|
|
- Diagrammes:
|
|
- Flux:
|
|
- 'Processus de signalement': diagrammes/flux/moderation-signalement.md
|
|
- États:
|
|
- 'Cycle de vie signalement': diagrammes/etats/signalement-lifecycle.md
|
|
- Séquences:
|
|
- "Processus d'appel modération": diagrammes/sequence/processus-appel-moderation.md
|
|
- Entités:
|
|
- 'Modèle modération': diagrammes/entites/modele-moderation.md
|
|
- Documentation Légale:
|
|
- Introduction: legal/README.md
|
|
- "Conditions Générales d'Utilisation": legal/cgu.md
|
|
- 'CGV Premium': legal/cgv-premium.md
|
|
- 'CGV Publicités': legal/cgv-publicites.md
|
|
- 'Charte Créateur': legal/charte-createur.md
|
|
- 'Mentions Légales': legal/mentions-legales.md
|
|
- 'Politique de Confidentialité': legal/politique-confidentialite.md
|
|
- Interfaces:
|
|
- Vue d'ensemble: interfaces/README.md
|
|
- Mobile:
|
|
- Navigation & Architecture: interfaces/mobile/navigation.md
|
|
- Mobile:
|
|
- 'Stratégie Permissions': mobile/permissions-strategy.md
|
|
- 'Validation TestFlight': mobile/testflight-validation-plan.md
|
|
- Conformité & Compliance:
|
|
- 'Soumission aux Stores': compliance/stores-submission.md
|
|
- Architecture & Techniques:
|
|
- Séquences:
|
|
- 'Cache Géospatial': architecture/sequences/cache-geospatial.md
|
|
- Modération (Gherkin):
|
|
- "Vue d'ensemble": gherkin-moderation-overview.md
|
|
- Tests BDD: bdd/
|
|
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com
|