Skip to content

docs: refonte README en page de légitimité (soin palier 0)#117

Merged
remigit55 merged 1 commit into
masterfrom
claude/readme-soin
Jun 15, 2026
Merged

docs: refonte README en page de légitimité (soin palier 0)#117
remigit55 merged 1 commit into
masterfrom
claude/readme-soin

Conversation

@remigit55

Copy link
Copy Markdown
Collaborator

Pourquoi

Le README décrivait Modular comme « open-source React component library
for business applications » — un pitch d'UI kit. La mission demande
l'inverse : un signal de soin et de catégorie, lisible en 30 s, qui
établit ce qu'est Modular (un fabricant d'instruments, pas un énième kit),
qu'il est vivant, où il s'installe, et son lien avec Maker.

Ce que fait cette PR

README refondu en page de légitimité dense (une page écran) :

  • Catégorie — phrase d'ouverture ancrée dans la primitive de jugement
    réelle interpret(value, context) (components/bpm/interpret.ts),
    vérifiée par le convergence gate (gate/interpret.test.ts).
  • Vivant — vitrine, app de démo, connecteur MCP (endpoint + doc).
  • Installer — npm et Python, commandes exactes, règle namespace
    conservée.
  • Preuvenpm run gate (la garantie θ-additive comme signal de soin).
  • Écosystème — lien Blueprint Maker (substrat → fabricant).

Faits vérifiés avant écriture (pas d'estimation)

  • 104 composants : compté dans lib/generated/bpm-components.json
    (source du doc-sync gate ; cohérent avec le compteur du serveur MCP).
  • interpret : primitive réelle et gate-testée — pas l'API inexistante
    que docs/site-report.md mettait en garde (elle existe désormais,
    exportée par le barrel bpm.tsx).
  • Licences corrigées : l'ancien README annonçait « MIT » en bloc.
    Réel : @blueprint-modular/core = Apache-2.0 (confirmé via
    registry.npmjs.org), blueprint-modular (PyPI) = MIT (pyproject.toml).
  • URLs : domaines canoniques tels que définis par le code lui-même
    (la page /mcp définit MCP_ENDPOINT = mcp.blueprint-modular.com/api/mcp).

Contraintes respectées

  • Aucun contenu technique d'installation supprimé sans réintégration :
    CSS/Tailwind/SSR/API détaillés restent dans
    packages/core/USAGE.md et public/llms.txt,
    désormais liés.
  • Aucun secret, aucune URL d'admin, aucune métrique de vanité.
  • Pas de capture inventée : aucune n'existe au dépôt → placeholder commenté
    • TODO. Le logo affiché (public/Logo-BPM-nom.jpg) est un fichier réel.

Validation

  • npx markdownlint-cli README.md → exit 0, aucune erreur.
  • Liens internes : tous les fichiers référencés existent.
  • Liens externes : PyPI (200) et registry.npmjs.org/@blueprint-modular/core
    (200) confirment l'existence des packages. Les domaines
    *.blueprint-modular.com / npmjs.com / blueprint-maker.com ne sont
    pas joignables depuis le sandbox
    (le proxy egress renvoie 403 même pour
    npmjs.com/example.com) — ils ne sont donc pas vérifiables par curl
    ici, mais sont les URLs canoniques définies dans le code. À re-vérifier hors
    sandbox.

Points laissés ouverts (TODO en commentaire dans le README)

  • Capture du showcase à exporter et substituer au placeholder.
  • Citation verbatim du Manifeste (repo memory,
    MANIFESTE_Blueprint.md, hors scope de cette session) à substituer à la
    phrase de catégorie quand une source publique existe ; en attendant, le
    lien « Positionnement » pointe vers /presentation.

https://claude.ai/code/session_01UPsEjVegLVH2jfnRNamyTk


Generated by Claude Code

@remigit55
remigit55 merged commit b54159e into master Jun 15, 2026
1 check passed
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.

2 participants