Welcome to the rlm-rs documentation! This directory contains comprehensive guides for using and contributing to rlm-rs, a Recursive Language Model CLI for handling long-context tasks.
Our documentation follows the Diátaxis framework, organized into four categories:
New to rlm-rs? Start here:
- Getting Started - 5-minute quick start tutorial
- Examples - Practical examples and workflows
Solve specific problems:
- CLI Reference - Complete command documentation
- Troubleshooting - Common issues and solutions
- Plugin Integration - Integration with Claude Code and other tools
Look up technical details:
- API Reference - Rust library documentation
- Features Guide - Feature flags and build options
- Glossary - RLM and chunking terminology
- FAQ - Frequently asked questions
Understand the design and architecture:
- RLM-Inspired Design - How rlm-rs builds on the RLM paper
- Architecture - Internal architecture and design
- ADRs - Architectural Decision Records
- Read the Getting Started tutorial
- Try the Examples
- Explore the CLI Reference
- Review CONTRIBUTING.md
- Study the Architecture
- Read the ADRs
- Check the API Reference
- Read Plugin Integration
- Review Features Guide
- Check API Reference
All documentation follows these guidelines:
- Plain English: Active voice, clear language
- Progressive Disclosure: High-level first, details second
- Code Examples: All examples are tested and functional
- Accessibility: Screen-reader friendly, semantic markup
- Searchable: Consistent terminology (see Glossary)
Documentation is as important as code! See our contribution guidelines for:
- Documentation style guide
- How to test documentation changes
- Submitting documentation PRs
- Changelog - Release history and migration notes
- RLM Paper - Original RLM research
- Issue Tracker - Bug reports and feature requests
Can't find what you're looking for?
- Check the FAQ
- Search the Troubleshooting Guide
- Browse GitHub Issues
- Ask in GitHub Discussions
Last Updated: 2026-02-18
Version: 1.2.4