powersync-docs/TODO_powersync-docs.md
Patrick Schurig 66aa71c990
All checks were successful
Build & Deploy docs / build-deploy (push) Successful in 2m38s
mise a jour
2026-06-06 09:51:43 +02:00

3.2 KiB

ETM PowerSync — Documentation : ToDo

État au 04/06/2026. La fondation docs-as-code est en place (CI verte, déploiement auto, 3 badges canal/origine/stabilité, catalogue complet, cycle de vie des forks). Reste la « chair » éditoriale + quelques dettes.

Priorités proposées (à valider par Patrick)

🔴 P1 — rapide & fort impact

  • Ajouter le plugin openmeteo (powersync-plugin-openmeteo) à PORTING_STATUS. Tourne déjà sur nymea-dev mais absent de la doc. Catégorie à définir (météo/données ? tarif/prévisions ?). → 1 ligne dans PORTING_STATUS.
  • Améliorer le rendu des « Détails par modèle » (voir capture abb-terra). Aujourd'hui Réglages / Grandeurs mesurées sont aplatis en une ligne illisible pleine de |. Le tableau Markdown ne se rend pas en tableau. → tâche Claude Code sur le générateur : produire de vrais tableaux lisibles (colonnes Clé / Libellé / Type / Unité / Plage / Défaut), ou des listes structurées.

🟠 P2 — documentation technique / API

  • Documentation MQTT (topics, payloads, intégration).
  • Documentation JsonRPC-API (nymea). RestAPI utile ? → à trancher.

🟡 P3 — contenu éditorial (au rythme de Patrick)

  • Section Getting Started / Installation : - [ ] version basée sur paquets APT (Auto / pro) - [ ] version Community : image Raspberry Pi + Raspberry Imager
  • Captures app mobile « comment ajouter un appareil » → page partagée installation/application.md (transversal, bénéficie à toutes les fiches).
  • Schémas de branchement (EN COURS — Patrick prépare les symboles) : - [ ] préparer les symboles (chantier Patrick) - [ ] famille comptage/puissance (attend la convention de tores par rôle : producteur / consommateur / maison → interfaces nymea smartmeter*) - [ ] intégration des SVG dans la prose des fiches
  • Étapes de paramétrage par appareil → prose fiche par fiche, au fil de l'eau.
  • Promotion des canaux : monter testing/stable les plugins éprouvés terrain. - [ ] décider statut Keba (testing ou stable selon usage prod réel) - [ ] vérifier Waveshare correct en ligne (après les reverts)

🟢 P4 — dette infra (mord dès que ça charge)

  • Ajouter de la RAM physique à pve01tm (→ 16 Go). Vrai correctif des 503. Le ballooning désactivé sur Gitea n'est qu'un palliatif sur un hôte à 7,7 Go sans marge. Investissement infra prioritaire.
  • Vérifier ce que fait MariaDB sur la VM Gitea (vu au htop) : utile à Gitea ou process qui traîne et grignote la RAM ?
  • Durcir la clé SSH de déploiement (command="" dans authorized_keys) — DMZ.

🔵 P5 — évolutions long terme

  • Chemin A : lire le canal directement depuis le dépôt APT reprepro (repos.etm-powersync.fr) une fois peuplé → supprime la double-saisie PORTING_STATUS ↔ APT.
  • Webhooks repos plugins → workflow docs, si le cron nocturne devient trop lent (pour l'instant OK).

« Je suis sûr on va encore trouver des choses à ajouter LOL » — oui. Garder ce fichier vivant, cocher au fur et à mesure.