Aller au contenu principal

Reference

Utilise cette zone lorsque la reponse doit rester exacte. Les pages de reference servent aux contrats, APIs, schemas, compatibility et surfaces de provenance generees qui doivent rester stables entre review, publication et readback live.

Commence par la surface exacte dont tu as besoin​

  • Api Reference — Utilise ceci lorsque tu as besoin de surfaces exactes d'API, d'event, de schema, de CLI, de MCP ou de configuration.
  • Compatibility — Utilise ceci lorsque le rollout, l'upgrade ou la supportabilite dependent de combinaisons de versions exactes.
  • Release Notes — Utilise ceci lorsque tu as besoin de l'historique de changement, du comportement cassant ou du contexte post-upgrade.
  • Platform Truth — Utilise ceci lorsque tu as besoin du contrat des docs publiques et du modele de publication de la verite runtime.
  • Contribute — Utilise ceci lorsque tu dois comprendre comment la verite de reference est revue et materialisee.

Ce qui appartient a la reference​

  • Les interfaces exactes, les formes de champs et les valeurs supportees.
  • La verite des versions et des releases qui doit rester reviewable et sans derive.
  • Les surfaces du systeme documentaire, des contrats et de la provenance qui expliquent comment les docs constructeur publiees sont generees.

Comment utiliser correctement cette zone​

  • Utilise Prise en main si tu as encore besoin d'un chemin guide dans la pile.
  • Utilise Operations si la surface est en panne et que tu as besoin de recovery ou de troubleshooting.
  • Utilise Modules si tu dois d'abord reduire la question a un outil Helpifyr avant de descendre dans des details versionnes.

Modele de qualite de la reference​

  • Fabric possede la verite canonique de docs-platform et du contrat de publication.
  • jhf-docs materialise les surfaces de reference revues mais ne doit pas inventer de verite API parallele.
  • Les pages de reference produit restent visibles meme lorsqu'elles sont bloquees, afin que les lecteurs puissent voir la provenance et le chemin source canonique manquant au lieu d'un trou silencieux.