Maintenir cette documentation

Ajouter une page et mettre à jour les guides dans la même modification que le produit.

Vérifié le 2026-10-12 · Version Markdown

Une source éditoriale par page#

Les guides sont des fichiers Markdown dans site/documentation/content/. Le registre site/documentation/pages.json porte l'URL stable, le titre, la rubrique, la description, la date de vérification et les sources de chaque page. Les fichiers générés ne se corrigent pas à la main.

La référence REST est reconstruite depuis packages/shared/openapi.json. Le catalogue MCP lit les définitions du registre TypeScript. La liste servie à une identité et les schémas personnalisés restent obtenus sur l'instance avec tools/list et describe_schema.

Ajouter ou corriger une page#

1. Modifiez le Markdown correspondant au sujet ou ajoutez un fichier avec un nom stable.
2. Renseignez le registre, notamment les chemins source qui justifient le contenu.
3. Relisez le parcours avec les libellés de l'interface et un exemple fictif.
4. Reliez la page aux guides voisins et ajoutez une note de version si nécessaire.
5. Exécutez les contrôles de documentation et ouvrez l'aperçu local.

npm run docs:check --workspace @cercla/site
npm run docs:build --workspace @cercla/site
npm run docs:preview --workspace @cercla/site

Les blocs de code, tableaux simples, listes, citations et liens internes sont pris en charge. Le HTML brut est affiché comme texte. Évitez les tableaux imbriqués, les notes de bas de page ou les syntaxes propres à un générateur externe.

Après une modification du produit#

npm run docs:impact --workspace @cercla/site -- --base origin/main

Ce rapport relie les chemins modifiés aux pages concernées. Il ne prétend pas décider automatiquement de la justesse du texte : relisez les pages signalées et mettez à jour leur date uniquement après vérification. Un changement sans page associée doit conduire à compléter la couverture ou à expliquer pourquoi il n'a pas d'effet documentaire.

Dans la même livraison#

Mettez à jour l'interface décrite, les exemples, les erreurs et les prérequis. Si l'API change, régénérez d'abord le contrat partagé. Si un nom d'outil MCP change, vérifiez aussi les recettes d'assistant. Conservez les URL de pages autant que possible pour ne pas casser les favoris et les liens d'aide.

Publication#

Le build du site produit la documentation dans son export statique. La chaîne existante de publication du site distribue cet export. Aucune donnée d'organisation, aucun secret et aucun dossier interne ne sont copiés automatiquement : seuls les contenus déclarés et les contrats publics entrent dans l'artefact.

La procédure détaillée de maintenance et de publication est conservée dans site/documentation/README.md pour les personnes disposant du dépôt.