# RLM-RS Documentation
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.
## 📚 Documentation Structure
Our documentation follows the [Diátaxis](https://diataxis.fr/) framework, organized into four categories:
### 🎓 Learning-Oriented (Tutorials)
New to rlm-rs? Start here:
- **[Getting Started](getting-started.md)** - 5-minute quick start tutorial
- **[Examples](examples.md)** - Practical examples and workflows
### 🛠️ Problem-Oriented (How-To Guides)
Solve specific problems:
- **[CLI Reference](cli-reference.md)** - Complete command documentation
- **[Troubleshooting](troubleshooting.md)** - Common issues and solutions
- **[Plugin Integration](plugin-integration.md)** - Integration with Claude Code and other tools
### 📖 Information-Oriented (Reference)
Look up technical details:
- **[API Reference](api.md)** - Rust library documentation
- **[Features Guide](features.md)** - Feature flags and build options
- **[Glossary](glossary.md)** - RLM and chunking terminology
- **[FAQ](faq.md)** - Frequently asked questions
### 💡 Understanding-Oriented (Explanation)
Understand the design and architecture:
- **[RLM-Inspired Design](rlm-inspired-design.md)** - How rlm-rs builds on the RLM paper
- **[Architecture](architecture.md)** - Internal architecture and design
- **[ADRs](adr/README.md)** - Architectural Decision Records
## 🚀 Quick Navigation
### First-Time Users
1. Read the [Getting Started](getting-started.md) tutorial
2. Try the [Examples](examples.md)
3. Explore the [CLI Reference](cli-reference.md)
### Developers
1. Review [CONTRIBUTING.md](../CONTRIBUTING.md)
2. Study the [Architecture](architecture.md)
3. Read the [ADRs](adr/README.md)
4. Check the [API Reference](api.md)
### Integrators
1. Read [Plugin Integration](plugin-integration.md)
2. Review [Features Guide](features.md)
3. Check [API Reference](api.md)
## 📋 Documentation Standards
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](glossary.md))
## 🤝 Contributing to Documentation
Documentation is as important as code! See our [contribution guidelines](../CONTRIBUTING.md) for:
- Documentation style guide
- How to test documentation changes
- Submitting documentation PRs
## 📦 Additional Resources
- **[Changelog](../CHANGELOG.md)** - Release history and migration notes
- **[RLM Paper](https://arxiv.org/abs/2512.24601)** - Original RLM research
- **[Issue Tracker](https://github.com/zircote/rlm-rs/issues)** - Bug reports and feature requests
## 🔍 Need Help?
Can't find what you're looking for?
1. Check the [FAQ](faq.md)
2. Search the [Troubleshooting Guide](troubleshooting.md)
3. Browse [GitHub Issues](https://github.com/zircote/rlm-rs/issues)
4. Ask in [GitHub Discussions](https://github.com/zircote/rlm-rs/discussions)
---
**Last Updated**: 2026-02-18
**Version**: 1.2.4