NRF Guide

Maintenance

Faire évoluer le wiki

Le site officiel se corrige dans le dépôt wiki, au même rythme que l’API.

Un site, une source versionnée

Les guides vivent dans app/content sous forme de pages structurées TypeScript, sans collection de fichiers Markdown à parcourir. Les composants Vue affichent les textes, exemples, tableaux et liens. La référence Kotlin est un instantané extrait des déclarations publiques du SDK.

Depuis le dépôt wiki
npm ci
npm run api:sync -- --sdk ../sdk
npm test
npm run typecheck
npm run generate

api:sync nécessite les sources du SDK localement ; le build du site utilise l’instantané versionné et reste autonome. Après une modification de l’API, révisez aussi les explications et exemples : une signature extraite ne remplace pas un tutoriel.

Préparer la mise en ligne

La génération produit un site statique dans .output/public. Le domaine prévu est wiki.nimbyrails-france.fr, servi en HTTPS par Caddy. Le fichier de déploiement du dépôt est un modèle à intégrer à la configuration existante ; il ne modifie pas le VPS.