Documentation intégrée à l'application
Chinaski embarque sa documentation dans la zone d'administration, Docs liste les articles intégrés ainsi que les articles que vous rédigez vous-même, le tout réservé aux admins. Cette page couvre les deux.
Les articles intégrés
Dix articles livrés sont livrés avec l'application, chacun couvrant un sous-système majeur (l'index de cette page se trouve dans Admin → Docs) :
- Blocks : création et gestion des blocs de contenu réutilisables ; types, format de template, intégration.
- Theme Authoring : la référence complète de Template Toolkit pour les templates de site et de bloc, avec les règles de sécurité et la référence complète des variables.
- LLM Theme Prompting : des conseils pour produire des thèmes ambitieux et visuellement distincts avec des assistants IA : briefs de design, specs de tokens, boucles de critique et modèles de prompts à copier-coller.
- Pages & Posts : création, édition, publication, planification, catégories, révisions.
- Navigation : construction des menus, ordre, liens externes, navigation par langue.
- Backups : création/restauration de sauvegardes, la planification, le format d'archive.
- Settings : nom du site, langues, défauts SEO, IDs analytics, l'avis cookies, configuration des URL.
- Media Library : téléversement, organisation, référence des URL de médias.
- MCP Server : le serveur Model Context Protocol pour la gestion assistée par IA.
- API Reference : la référence complète de
/api/*(authentification, pagination, corps de requête, schémas de réponse).
La documentation va plus loin que le site de documentation public, par exemple, l'article Theme Authoring porte la table complète des variables de stash par type de template.
Rédiger vos propres articles
À côté des articles intégrés, il existe un ensemble éditable pour les docs personnalisées (vos pages de procédures pour les éditeurs, règles de style maison, notes de migration pour un client) et ce sont des données entièrement dans le dépôt :
- New article : un titre est requis ; le slug vient de votre saisie ou s'auto-génère depuis le titre (minuscules, séparées par des tirets) ; les caractères de slug invalides sont retirés.
- Sort order : contrôle la position de lecture sur l'index des docs (l'ordre départage les égalités par ordre de création).
- Body : du texte de corps arbitraire, éditable par article ; enregistré dans la base de données (avec les sauvegardes de votre instance, comme tout le reste).
L'index liste vos docs personnalisées sous les articles intégrés, triées selon vos ordres de tri. Tout ce que vous écrivez reste une donnée locale à l'instance ; rien n'est synchronisé ni publié publiquement ; écrivez vos runbooks comme documentation interne pour votre équipe.
La documentation est un territoire d'admin
Parce que certains articles couvrent des opérations privilégiées (entrailles des thèmes, clés API, agencement des sauvegardes), chaque route de doc, y compris les brouillons, est verrouillée pour les admins : les éditeurs sans rôle admin ne voient jamais cette section.