Skip to content

Créer un README.md conforme ADR-0047 (découvrabilité) #1

@spouletmathis

Description

@spouletmathis

Contexte

Détecté par l'audit de découvrabilité ADR-0047 du 2026-02-20.

Le repo alter-web est un repo de déploiement statique (artefacts de build Flutter) qui ne contient aucun README.md. Cela provoque 4 FAIL sur les règles de découvrabilité :

Règle Statut Description
R1 Cross-référencement FAIL Aucune mention des 5 interfaces de l'écosystème
R2 Exemples concrets FAIL Aucun bloc code
R3 Liens absolus FAIL Rien à vérifier (pas de README)
R4 Sommaire écosystème FAIL Pas de tableau des interfaces

Réflexion préalable

Ce repo a un statut particulier : c'est un repo de déploiement (artefacts compilés), pas un repo de développement. Plusieurs questions à trancher avant d'agir :

  1. Public ou privé ? — Si le repo est privé et non visible des utilisateurs, un README de découvrabilité a-t-il du sens ? Le public cible (agents IA, développeurs) le consulte-t-il ?

  2. README minimal vs complet ? — Un repo de déploiement pourrait avoir un README très court (sommaire écosystème + lien vers le repo source phoenix_0) plutôt qu'une documentation complète.

  3. Redirection vs contenu ? — Alternative : un README d'une ligne renvoyant vers le README principal de phoenix_0, plutôt que dupliquer le sommaire écosystème.

  4. Faut-il adapter ADR-0047 ? — Peut-être que les repos de déploiement (artefacts compilés) devraient être exemptés ou avoir des règles allégées dans l'ADR.

Ce qui est attendu (si on maintient les règles actuelles)

Un README.md contenant au minimum :

  • R4 : Tableau des 5 interfaces dans les 20 premières lignes
  • R1 : Mention de alter-cli, alter-mcp, Alter Desktop, Alter Mobile
  • R2 : Un bloc code (ex: URL du site, commande curl)
  • R3 : Uniquement des liens absolus (https://...)

Référence

  • ADR-0047 (découvrabilité)
  • Audit du 2026-02-20 : seul point bloquant (4/4 FAIL sur cette surface)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions