Skip to content
DP-DOCSRelu · 2026-11-19Desktop 1.8 · Companion 1.1.1Read in English

Maintenir cette référence ​

Une référence liée au code ​

documentation/topics.mjs définit identifiants stables, routes, titres, groupes et sources. Le français est à la racine ; l'anglais sous /en/ avec les mêmes routes. Les IDs DP-… permettent de citer un sujet indépendamment du titre traduit. Chaque page affiche date de revue, composants concernés et sources.

Pour une règle modifiée : lire le module et ses tests, modifier la page FR et sa paire EN, vérifier les exemples, ajouter ou remplacer l'ADR si nécessaire. Une date de revue indique une vérification humaine du contenu ; elle ne doit pas avancer automatiquement à chaque build.

Écrire et vérifier ​

sh
npm --prefix documentation ci --ignore-scripts
npm --prefix documentation run dev
npm --prefix documentation run verify

Le build produit .work/docs-site. Le serveur de documentation portable ne sert que les fichiers compilés, sur loopback, en lecture seule. Utiliser HTTP local : ouvrir directement index.html en file:// n'est pas le parcours pris en charge pour recherche et navigation.

Le vérificateur contrôle les paires, métadonnées, chemins de sources, liens internes et cohérence des versions. VitePress vérifie les liens pendant la compilation. Les tests du serveur couvrent lecture, HEAD, méthodes refusées et traversée de chemins. L'inspection visuelle complète ces preuves pour recherche, changement de langue et petite fenêtre.

Conventions éditoriales ​

Décrire comportement actuel, hypothèse et proposition future séparément. Toujours donner l'unité et la portée d'un seuil. Ne pas traduire les clés d'API. Préférer un exemple synthétique calculable à une capture personnelle. Ne jamais annoncer « réalisé » pour un profit estimé. Maintenir des liens relatifs au site et des références de code précises.

La parité structurelle ne prouve pas une traduction correcte : le reviewer compare les sens et valeurs numériques. Les deux pages doivent être mises à jour dans la même PR. En cas de changement de route, ajouter une redirection explicite et vérifier les anciens liens avant suppression.

Les liens de preuve pointent vers le tag documentaire immuable (docs-v1.0.0) ; les liens de correction suivent volontairement main. Mettre à jour cette référence à chaque version documentaire.

Livrer un manuel portable ​

Après installation des dépendances à la racine et dans documentation, exécuter npm --prefix documentation run package. Cette commande vérifie et compile le site, puis produit dans artifacts/ un ZIP Windows x64 avec lecteur local, Node officiel vérifié par checksum, notices et manifeste des fichiers. Extraire le ZIP complet puis ouvrir OPEN-DOCS.cmd. Le contenu et la recherche fonctionnent hors ligne ; seuls les liens externes nécessitent une connexion. Sur Linux/macOS avec Node installé, utiliser node scripts/serve-docs.mjs site --open depuis le dossier extrait.

Un conseiller local. Des estimations explicites.