Skip to Content
SymfonyConventions de rédaction

Conventions de rédaction de cette documentation

Chaque chapitre (NN-slug.mdx) suit ce template :

  1. Titre H1 (# Chapitre X.Y — …), puis un bandeau de situation (partie, numéro, public, version de référence) et un encadré résumé :

    ⏱️ TL;DR — 5 à 10 puces qui résument tout le chapitre.

  2. ## 🎯 Objectifs — « à la fin de ce chapitre, vous saurez… » (3 à 6 puces).

  3. Corps détaillé — prose pédagogique en français, nombreux exemples concrets : code PHP/Symfony complet et copiable, chemin du fichier en commentaire d’en-tête du bloc (// src/Entity/Booking.php), scénarios réalistes tirés de l’app fil rouge BookLab.

  4. Diagrammes — blocs ```mermaid (flowchart, sequenceDiagram, erDiagram, stateDiagram) pour les architectures / flux / relations ; ASCII pour les arborescences de fichiers. Pas d’images binaires : Mermaid est rendu nativement par Nextra.

  5. Encadrés récurrents :

    • > ⚠️ **Piège** : — erreur classique et comment l’éviter.
    • > 💡 **Pour un dev Next.js** : — analogie / pont avec l’écosystème Next.js / React / TypeScript.
    • > ⚡ **Depuis Symfony 5** : — ce qui a changé depuis Symfony 5 (le lecteur connaissait cette version).
    • > 🐘 **Rappel PHP 8+** : — micro-rappel d’une nouveauté PHP 8.0→8.4 utilisée juste avant.
    • > 📚 **Aller plus loin** : — liens vers la doc officielle (symfony.com, api-platform.com…).

  6. ## ✏️ Exercices — 3 à 6 exercices progressifs et concrets, chacun avec sa solution repliée dans un bloc :

    <details>
  <summary>✅ Solution</summary>
  …
</details>

  7. ## 🧠 Quiz de révision — 5 questions, réponses repliées dans <details>.

  8. Lien vers le chapitre suivant en dernière ligne.

Les fichiers index.mdx d’une partie font exception : sommaire de la partie, résumé d’une phrase par chapitre, et « ce que vous saurez faire à la fin de cette partie ».

Règles techniques du site (Nextra 4 / MDX)

  • Liens internes = chemins absolus du site : /06-doctrine/03-relations, pas de .mdx, pas de relatif.
  • Accolades {...} hors code : en MDX, { ouvre une expression JS. Dans la prose, mettre tout {...} entre backticks (`{id}`) ou l’échapper. Vrai aussi pour les templates Twig ({{ … }}, {% … %}) et l’interpolation PHP ("$var" va bien, mais "{$var}" dans un paragraphe hors code casse le rendu).
  • <details> / <summary> doivent être sur des lignes séparées du contenu.
  • Couleur de marque Mermaid : émeraude #10a37f.

Référence technique

Symfony 7.4 LTS (novembre 2025, PHP 8.2+ requis — on vise 8.3/8.4). PHP moderne, Flex, AssetMapper, Symfony UX, API Platform 4, Doctrine ORM 3. Tout écart de version est signalé dans le texte. Symfony 8.0 est sorti en parallèle de 7.4 (novembre 2025 ; 8.0 = 7.4 sans le code déprécié), 8.1 en mai 2026 ; les spécificités 8.x sont signalées via des encadrés « ⚡ » lorsque pertinent. On travaille sur la LTS 7.4.

Quiz 5 — Expert & carrière