AI-Optimized Documentation

Machine-readable documentation for AI assistants, coding copilots, and LLM-powered tools.

What is llms.txt?

The llms.txt convention provides AI assistants with structured, plain-text documentation optimized for context windows. This helps tools like Claude, ChatGPT, GitHub Copilot, and Cursor understand how to use @sveltopia/regions correctly.

Available Files

llms.txt

Quick overview with core concepts, installation, and links to detailed documentation.

~1KB - Best for quick context

llms-full.txt

Complete reference with all APIs, code examples, strategies, and advanced patterns.

~10KB - Full documentation

How to Use

With Claude, ChatGPT, or similar

Paste the contents of llms-full.txt into your conversation, or ask the AI to fetch it:

"Read https://regions.sveltopia.dev/llms-full.txt and help me add a page header region"

With Cursor or VS Code + Copilot

Add to your project's AI context or reference the URL in your prompt:

@https://regions.sveltopia.dev/llms-full.txt

Download for offline use

Save locally and include in your project's documentation context:

llms.txt llms-full.txt

What's Included

The full documentation covers:

Installation & Setup - Package install and root layout configuration
Three Strategies - Load functions, component wrappers, and snippets with code examples
API Reference - LayoutRegions, LayoutRegion, useLayoutRegions, RegionSchema
CLI Tool - Generator commands and interactive prompts
Validation - Valibot, Zod, and TypeScript-only approaches
Advanced Patterns - Layout-level regions, inheritance, mixing strategies
Decision Guide - When to use each strategy

About the Convention

The llms.txt convention was popularized by the AI development community as a way to provide documentation that's optimized for LLM context windows. Unlike HTML documentation, these plain-text files:

Use minimal tokens (no HTML/CSS overhead)
Include complete code examples
Follow a consistent, parseable structure
Can be easily fetched and included in AI prompts