documentation
Kohinos v3 Doc générée le commit 8d60b1904

Vérificateur de liens — doc HTML Kohinos

La doc statique dochtml/ regroupe près d'une centaine de pages reliées entre elles par des liens relatifs. Sans contrôle automatisé, un renommage de page ou la suppression d'une ancre passe inaperçu. Ce script Python local — sans dépendance externe, sans appel réseau par défaut — détecte les liens cassés et les ancres manquantes avant qu'un lecteur ne tombe sur un 404.

Pourquoi un script maison

Ce que le script vérifie

Type de lienVérificationRéseau ?
Interne relatif (./page.html, ../dev/api.html) Le fichier cible existe sur le disque Non
Ancre intra-page (#section) L'id ou name existe dans la page courante Non
Ancre cross-page (./page.html#section) Fichier et ancre existent Non
Externe (https://...) Ignoré sauf si --check-external (HEAD HTTP, timeout 5 s) Oui — opt-in
mailto:, tel:, javascript:, data: Ignorés Non

Usage local

python3 scripts/check-doc-links.py
python3 scripts/check-doc-links.py --json --check-external
Attention — trafic réseau

L'option --check-external émet une requête HTTP HEAD vers chaque URL externe (timeout 5 s). Elle est incompatible avec un pipeline 100 % offline et peut être bloquée par un firewall sortant. À n'activer que ponctuellement, lors d'un audit éditorial, pas dans le job CI par défaut.

Intégration Woodpecker CI

Le moteur CI est Woodpecker (cf. page CI/CD + ADR 0028). Une pipeline financière ne doit jamais être ralentie ou bloquée par un lien cassé sur une page de doc : la vérification de liens est donc un step non bloquant (failure: ignore), idéalement isolé dans le pipeline nightly.yml plutôt que dans pr.yml/main.yml.

# Step à ajouter à .woodpecker/nightly.yml (non bloquant) :
  - name: docs-link-check
    image: php:8.4-cli-alpine
    commands:
      - php scripts/check-doc-links.php
    failure: ignore   # un lien mort ne doit jamais bloquer un correctif financier

Caractéristiques recommandées du step :

🛈 À ce jour ce step n'est pas encore câblé dans .woodpecker/*.yml : la vérification se lance manuellement en local. L'ajouter à nightly.yml reste une évolution à planifier.

Sortie type

Vérification des liens documentation Kohinos
  Répertoire     : /home/julien/kohinos/dochtml
  Pages scannées : 88
  Liens analysés : 1950
  OK             : 1583
  Externes ignorés : 357 (activer avec --check-external)

[KO] 9 lien(s) cassé(s) :
  - dochtml/user/glossaire.html  →  #flux
      anchor : ancre #flux absente de la page

Limites connues

Liens utiles