Le wiki : gabarit de page et méthode¶
Aide-mémoire pour rédiger une page du wiki sans se tromper de forme ni d'emplacement. Les règles détaillées sont dans Règles de rédaction ; cette page est la version courte, celle qu'on ouvre quand on a déjà décidé de la page mais pas encore du format.
🗂️ Trouver la bonne section¶
| Si la page parle de… | Section |
|---|---|
| la machine NAS, son stockage, ses partages | nas/ |
| Linux générique (Docker, comptes, paquets) | systeme/ |
| ce qui relie les machines (DNS, synchro) | reseau/ |
| une application auto-hébergée | services/ |
| Kodi, vidéo, DVD, VHS | medias/ |
| OctoPrint, trancheurs | impression-3d/ |
| un appareil précis | materiel/ |
| le reste | divers/ |
| une page abandonnée | obsoletes/ |
🧱 En-tête à copier tel quel¶
---
title: Titre affiché dans le menu
created: 2026-11-10
updated: 2026-11-10
tags: theme, sujet
---
updated change à chaque retouche. C'est la seule mesure de fraîcheur du
wiki, et elle est lue par le sommaire des pages obsolètes.
📛 Nommage du fichier¶
Minuscules, tirets, sans accents : onduleur-nut.md. Jamais d'espace, jamais de
majuscule, jamais de date en préfixe.
🎨 Emojis¶
Un emoji par ## de contenu, choisi pour le sujet :
| 🏗️ architecture | ⚙️ configuration |
| 🛠️ préparation | 🚀 déploiement |
| 🧪 vérifications | 🌐 réseau |
| 💾 stockage | 🔑 secrets |
| 📦 installation | 🔧 maintenance |
| 🎮 usage |
Pas d'emoji sur ## Voir aussi. Un emoji ne remplace jamais un mot.
✅ Avant de committer¶
Le build doit sortir en code 0. --strict signale un lien mort ou une page
absente de la navigation — ne pas committer tant qu'il n'est pas vert.
📜 Commit¶
Un commit par intention. Le message dit ce qui change, pas « mise à jour ».
⚠️ Trois pièges¶
gen_nav.pyécrase les index de section : les retouches manuelles d'undocs/<section>/index.mdsont perdues. Modifier le script, pas le fichier.- L'accueil
docs/index.mdn'est pas généré : il se met à jour à la main quand une page apparaît ou change de place. - Vérifier avant de corriger en série. Une adresse ou un chemin faux se répète souvent à plusieurs endroits ; chercher toutes les occurrences.
Voir aussi¶
- Règles de rédaction — la version complète
- piNAS — exemple de fiche machine
- Onduleur (NUT) — exemple de page technique longue