Skip to main content
View as Markdown

Référence LLM

Sovrium fournit des fichiers de documentation lisibles par les machines, conçus pour les grands modèles de langage (LLM) et les assistants de codage IA. Utilisez ces fichiers pour donner aux outils IA un contexte complet sur le schéma d'application Sovrium, la CLI, l'API et le format de configuration.

Qu'est-ce que llms.txt ?

Un standard émergent pour fournir de la documentation aux assistants IA dans un format adapté aux machines.

La convention llms.txt est un standard croissant où les sites web servent des fichiers de documentation en texte brut à des URL bien connues (/llms.txt et /llms-full.txt). Ces fichiers sont spécifiquement formatés pour être consommés par les grands modèles de langage, fournissant des informations structurées sur le projet, ses API, son format de configuration et ses capacités. Sovrium publie deux fichiers : une référence rapide compacte pour les consultations rapides, et une référence complète exhaustive pour générer des configurations et répondre aux questions détaillées.

Les fichiers

Deux fichiers de documentation optimisés pour différents cas d'utilisation.

llms.txt

https://sovrium.com/llms.txt

Vue d'ensemble compacte avec des liens vers toutes les sections de documentation. Idéal pour un contexte rapide et la navigation.

  • Taille : environ 40 lignes — s'intègre facilement dans n'importe quelle fenêtre de contexte LLM.
  • Cas d'usage : à utiliser lorsque vous avez besoin d'un résumé rapide ou que vous souhaitez orienter un outil IA vers des sections spécifiques de la documentation.

llms-full.txt

https://sovrium.com/llms-full.txt

Documentation complète couvrant l'ensemble de la plateforme Sovrium. Idéal pour une assistance IA approfondie.

  • Taille : environ 3000 lignes — référence complète en un seul fichier.
  • Cas d'usage : à utiliser lorsque vous souhaitez qu'un assistant IA dispose d'un contexte complet sur Sovrium, génère des configurations ou réponde à des questions détaillées.

La référence complète couvre :

  • Les guides de démarrage
  • L'aperçu du schéma et les propriétés racine
  • Les 49 types de champs
  • Tous les types de composants
  • La configuration de l'authentification
  • Le thème et les tokens de design
  • Les pages et les interactions
  • Les langues et l'i18n
  • La configuration de l'analytique
  • La référence de l'API (enregistrements, authentification, admin, santé)
  • Des exemples YAML complets
  • La référence du schéma JSON

Utilisation avec les outils IA

Comment fournir la documentation Sovrium à votre assistant IA de choix.

Récupérez la documentation directement :

# Quick reference (~40 lines)
curl https://sovrium.com/llms.txt

# Complete documentation (~2700 lines)
curl https://sovrium.com/llms-full.txt

Collez l'URL ou le contenu dans votre assistant IA avec un prompt comme :

Read the Sovrium documentation from https://sovrium.com/llms-full.txt
and help me create an app.yaml configuration for a blog with:
- A posts table with title, content, and published_at fields
- Email/password authentication
- A homepage with a list of recent posts

Créer des applications Sovrium avec l'IA

Parce qu'une application Sovrium est un unique fichier de configuration déclaratif, elle constitue une cible idéale pour la rédaction assistée par l'IA. Une boucle pratique :

  1. Donnez le contexte à l'IA. Orientez-la vers llms-full.txt pour qu'elle connaisse l'intégralité du schéma — les 49 types de champs, les types de composants, les options d'authentification et la surface de l'API REST.
  2. Rédigez en TypeScript pour la sûreté de typage. Demandez à l'IA de générer un app.ts en utilisant defineConfig() de @sovrium/types. Votre éditeur valide alors la sortie de l'IA au fil de l'écriture, en détectant en ligne les types de champ invalides et les sections mal formées.
  3. Validez avant d'exécuter. Exécutez sovrium validate app.ts (voir la Référence CLI) pour confirmer que la configuration se décode par rapport à AppSchema, en faisant remonter les types de champ inconnus et les erreurs structurelles avec le code de sortie 1.
  4. Itérez face à l'application en cours d'exécution. Démarrez avec sovrium start app.ts --watch ; l'IA peut affiner la configuration et le serveur se recharge à chaud à l'enregistrement.