Skip to content

Move to new doc system#3252

Open
zoic21 wants to merge 13 commits intodevelopfrom
feat/doc
Open

Move to new doc system#3252
zoic21 wants to merge 13 commits intodevelopfrom
feat/doc

Conversation

@zoic21
Copy link
Copy Markdown
Contributor

@zoic21 zoic21 commented Apr 13, 2026

🚀 Refonte du système de documentation

Cette PR introduit une refonte complète du système de documentation afin de simplifier la maintenance, améliorer la cohérence et réduire la complexité globale.

🔧 Changements principaux

Migration vers GitHub Pages par dépôt
La documentation est désormais directement hébergée via GitHub Pages sur chaque dépôt, au lieu d’utiliser un dépôt centralisé.
→ Cela permet une gestion indépendante, plus simple et plus cohérente avec le cycle de vie des projets.
Suppression du système de traduction interne
Les traductions ne sont plus gérées dans le dépôt.
→ On s’appuie désormais sur les fonctionnalités natives de traduction des navigateurs, ce qui supprime une source importante de complexité et de maintenance.
Mise en place d’un template unifié
Un template commun est introduit pour l’ensemble des documentations.
→ Il permet :

  • une structure homogène entre les projets
  • la génération automatique du menu
  • une meilleure maintenabilité globale

🎯 Objectifs

Réduire la dette technique liée à la documentation
Simplifier les contributions
Uniformiser l’expérience utilisateur
Supprimer les dépendances inutiles (traduction, repo central)

🔍 Démonstration

Un exemple du rendu final est disponible ici :
👉 https://jeedom.github.io/core/

@Mips2648
Copy link
Copy Markdown
Collaborator

Mips2648 commented Apr 13, 2026

Salut,
J'essaie de tester pour avoir la doc en anglais par exemple, comment on fait?
je suis sur un navigateur qui déclare en_us comme langue voulue mais la page s'affiche toujours en Fr, je ne comprend pas comment c'est sensé fonctionner
image

ca veut dire quoi:

→ On s’appuie désormais sur les fonctionnalités natives de traduction des navigateurs

Copy link
Copy Markdown
Contributor

@Salvialf Salvialf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Je n'arrive pas à tester, il y a des choses spéciales à mettre en place pour avoir le texte traduit ? J'ai beau changer la langue du navigateur c'est toujours en français mais avec des soucis de syntaxe (des espaces qui apparaissent dans les liens URL notamment).

Autre question, quid de la documentation actuelle ? La présente PR est à part sous un format différent pour tester ou il va falloir revoir jeedom/documentations en intégralité ?

@zoic21
Copy link
Copy Markdown
Contributor Author

zoic21 commented Apr 13, 2026

Normalement ton navigateur te propose la traduction mais il ne faut pas avoir desactiver la traduction pour la langue source (fr ici). Si tu as fait comme moi il ne traduit pas le fr et le en automatiquement.

Copy link
Copy Markdown
Collaborator

@Mips2648 Mips2648 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An automatic translation mechanism via the browser will bring many issues like these:
Image

How is it plan to fix that?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants