The llms.txt file is a machine-readable index of all Ably documentation pages, designed to help LLMs and AI assistants discover and navigate the documentation.
What is llms.txt?
The llms.txt file follows the llms.txt specification, providing a structured list of all documentation pages with their titles and descriptions. This makes it easy for AI assistants to understand what documentation is available and find relevant pages for your questions.
How to access
The file is available at:
https://ably.com/llms.txtYou can point your AI assistant to this URL when you need help finding documentation on a specific topic.
File structure
The llms.txt file organizes documentation into categories:
Platform
Core platform documentation including account management, architecture, pricing, integrations, and the Control API.
Pub/Sub
Documentation for Ably's core realtime messaging capabilities: channels, messages, presence, authentication, connections, and protocols.
Chat
The Ably Chat product documentation covering rooms, messages, reactions, typing indicators, and moderation features.
Spaces
Multiplayer collaboration features including live cursors, avatar stacks, member locations, and component locking.
LiveObjects
Shared state management for building collaborative applications with synchronized data.
LiveSync
Database synchronization documentation for MongoDB and PostgreSQL integrations.
Entry format
Each entry in the file follows this format:
- [Page Title](URL): Description of the page contentFor pages with multiple language variants, additional entries are included with the language specified:
- [Page Title (JavaScript)](URL?lang=javascript): Description
- [Page Title (Python)](URL?lang=python): DescriptionAuto-generated
The llms.txt file is automatically generated at build time from all documentation pages. It stays up-to-date with the latest documentation structure and content.