Comment cette doc fonctionne

Cette page est destinée aux contributeurs techniques. Elle explique comment ajouter ou modifier du contenu dans la documentation.

Architecture

Ce site est construit avec :

Next.js 15 (App Router)
Fumadocs — le framework de documentation
MDX — Markdown avec composants React
Tailwind CSS — pour les styles

Le contenu se trouve dans content/docs/. Chaque fichier .mdx devient une page.

Ajouter une page

Créez un fichier .mdx dans le bon dossier (ex: content/docs/design/ma-page.mdx)
Ajoutez le frontmatter en haut du fichier :

---
title: Titre de ma page
description: Description courte pour le SEO
icon: NomIconeLucide
---

Écrivez votre contenu en Markdown
Si vous créez un nouveau dossier, ajoutez un fichier meta.json pour définir l'ordre des pages :

{
  "title": "Ma section",
  "pages": ["index", "page-1", "page-2"]
}

Composants disponibles

Fumadocs fournit des composants prêts à l'emploi :

Cards

<Cards>
  <Card title="Titre" href="/lien" />
  <Card title="Autre" href="/autre" />
</Cards>

Callouts

<Callout type="info">
  Information importante
</Callout>

Types disponibles : info, warning, error

Steps

<Steps>
  <Step>Première étape</Step>
  <Step>Deuxième étape</Step>
</Steps>

Icônes

Les icônes viennent de Lucide. Utilisez le nom exact dans le frontmatter :

---
icon: Rocket
---

Lancer en local

# Installer les dépendances
pnpm install

# Lancer le serveur de dev
pnpm dev

# Builder pour la production
pnpm build

Structure des fichiers

content/docs/
├── index.mdx          # Page d'accueil de la doc
├── meta.json          # Navigation principale
├── faq.mdx
├── glossaire.mdx
├── fondations/
│   ├── index.mdx
│   ├── meta.json
│   ├── stack.mdx
│   └── standards.mdx
├── design/
│   └── ...
└── ...

Bonnes pratiques

Un sujet par page — si la page fait plus de 800 mots, découpez
Titres actionnables — "Comment configurer X" > "Configuration"
Exemples concrets — montrez, ne dites pas
Mettez à jour la date — si vous modifiez significativement une page

Guide technique