Readit Documentation

Welcome to the official documentation for Readit. This guide provides everything you need to understand and use Readit to inject powerful, portable context into your AI agents.

Documentation Structure

Getting Started

• Overview - Introduction to Readit and core concepts

Core Concepts

• Anatomy of a Readit - Understanding Readit structure and components
• Visibility Levels - Public, private, and unlisted access controls

Advanced Features

• File Embedding (Transclusion) - Embed content between files
• Templating Engine - Dynamic content with Liquid templating
• Search - Full-text search within Readits

Use Cases

• Context Injection - Practical scenarios for context injection
• Guidelines as Source of Truth - Company policies and guidelines
• Agentic Documentation - Interactive documentation for customers

Integrations

• Popular AI Tools - Integration with ChatGPT, Claude, and other AI tools
• API Examples - Code examples for automation and CI/CD
• Documentation Drift Detector - Keep docs aligned with code

Reference

• FAQ - Frequently asked questions
• Common Patterns - Reusable templates and examples

Quick Start

1. Create a Readit - Package your instructions and context into Markdown files
2. Set Visibility - Choose public, private, or unlisted access
3. Share the Link - Use the Readit URL in your AI prompts
4. Iterate - Update content as needed, links stay the same

Why Readit?

Readit solves critical problems in working with LLMs:

• Minimizes Hallucinations by providing clear, bounded context
• Ensures Reproducibility with consistent outputs across sessions
• Enables Collaboration through shareable, version-controlled context
• Maintains Security with token-based access controls