Skip to main content
View as Markdown

LLM Reference

Sovrium provides machine-readable documentation files designed for Large Language Models (LLMs) and AI coding assistants. Use these files to give AI tools full context about the Sovrium app schema, CLI, API, and configuration format.

What is llms.txt?

An emerging standard for providing documentation to AI assistants in a machine-friendly format.

The llms.txt convention is a growing standard where websites serve plain-text documentation files at well-known URLs (/llms.txt and /llms-full.txt). These files are specifically formatted for Large Language Models to consume, providing structured information about the project, its APIs, configuration format, and capabilities. Sovrium publishes two files: a compact quick reference for fast lookups, and a comprehensive full reference for generating configurations and answering detailed questions.

The Files

Two documentation files optimized for different use cases.

llms.txt

https://sovrium.com/llms.txt

Compact overview with links to all documentation sections. Best for quick context and navigation.

  • Size: About 40 lines — fits easily in any LLM context window.
  • Use case: Use when you need a quick summary or want to point an AI tool to specific documentation sections.

llms-full.txt

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

Complete documentation covering the entire Sovrium platform. Best for deep AI assistance.

  • Size: About 3000 lines — comprehensive, single-file reference.
  • Use case: Use when you want an AI assistant to have full context about Sovrium, generate configurations, or answer detailed questions.

The full reference covers:

  • Getting Started guides
  • Schema Overview & Root Properties
  • All 49 Field Types
  • All Component Types
  • Authentication configuration
  • Theme & design tokens
  • Pages & interactions
  • Languages & i18n
  • Analytics configuration
  • API Reference (records, auth, admin, health)
  • Complete YAML examples
  • JSON Schema reference

Usage with AI Tools

How to feed Sovrium documentation to your AI assistant of choice.

Fetch the documentation directly:

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

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

Paste the URL or content into your AI assistant with a prompt like:

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

Building Sovrium apps with AI

Because a Sovrium app is a single declarative config file, it is an ideal target for AI-assisted authoring. A practical loop:

  1. Give the AI context. Point it at llms-full.txt so it knows the full schema — all 49 field types, component types, auth options, and the REST API surface.
  2. Author in TypeScript for type safety. Have the AI generate an app.ts using defineConfig() from @sovrium/types. Your editor then validates the AI's output as it writes, catching invalid field types and misshaped sections inline.
  3. Validate before running. Run sovrium validate app.ts (see the CLI Reference) to confirm the config decodes against AppSchema, surfacing unknown field types and structural errors with exit code 1.
  4. Iterate against the running app. Start with sovrium start app.ts --watch; the AI can refine the config and the server hot-reloads on save.