# Maintenir cette documentation

Source : https://docs.berkios.online/reference/maintenir-la-doc/ · Section : Référence · Documentation officielle BERKIOS (https://docs.berkios.online)


Ce site est généré à partir de fichiers Markdown. Pour ajouter ou corriger une page, vous modifiez un fichier texte, puis vous relancez la génération.

## Où sont les pages ?

```text nocheck
content/
  commencer/   Choisir, installer
  studio/      Parcours BERKIOS Studio
  core/        Parcours BERKIOS Core
  code/        Parcours BERKIOS Code (.bk)
  reference/   Commandes, ligne de commande
nav.json       Ordre des pages et du menu
build.mjs      Générateur du site
```

## Ajouter une page

1. Créez `content/core/ma-page.md`. La première ligne `# Titre` devient le titre de la page.
2. Ajoutez-la dans `nav.json`, dans la bonne section.
3. Relancez la génération : `node build.mjs`.

## Régénérer la référence des commandes

La page « Catalogue des commandes » est produite par le dépôt BERKIOS lui-même (`node scripts/generate-commands-doc.mjs`) afin de ne jamais diverger du code. Copiez le fichier généré dans `content/reference/08-cent-nouvelles-commandes.md`.

## Garder les exemples exacts

```bash
BERKIOS_BIN=chemin/vers/compiler/bin/berkios.mjs node scripts/check-snippets.mjs
```

Ce script compile chaque exemple de code des sections Core et Code. Ajoutez-le à votre intégration continue : une page dont l'exemple ne compile plus fait échouer la vérification. Pour un extrait volontairement incomplet, écrivez ```` ```text nocheck ````.

## Bonnes pratiques

- Un exemple = un programme complet que le lecteur peut copier-coller.
- Montrez le **résultat** attendu après chaque exemple.
- Une idée par page, des phrases courtes.
- Indiquez les limites (ce qui ne marche pas encore) plutôt que de les cacher.