# TinyRag Documentation

Welcome to TinyRag - a lightweight, powerful Python library for Retrieval-Augmented Generation (RAG) applications.

## 📚 Documentation Structure

### Getting Started
- [**Quick Start**](01-quick-start.md) - Get up and running in 5 minutes
- [**Installation**](02-installation.md) - Complete installation guide
- [**Basic Usage**](03-basic-usage.md) - Simple examples without LLM

### Core Features
- [**Document Processing**](04-document-processing.md) - PDF, DOCX, CSV, TXT support
- [**Codebase Indexing**](05-codebase-indexing.md) - Function-level code search
- [**Vector Stores**](06-vector-stores.md) - Memory, Faiss, Pickle, ChromaDB
- [**Search & Query**](07-search-query.md) - Similarity search without LLM

### LLM Integration
- [**Custom System Prompts**](08-system-prompts.md) - Customize AI behavior
- [**Chat Functionality**](09-chat-functionality.md) - RAG-powered conversations
- [**Provider Configuration**](10-provider-config.md) - API setup and models

### Advanced Usage
- [**Performance Optimization**](11-performance.md) - Speed and memory tips
- [**Configuration Options**](12-configuration.md) - All parameters explained
- [**Best Practices**](13-best-practices.md) - Production recommendations
- [**Troubleshooting**](14-troubleshooting.md) - Common issues and solutions

### Examples & Use Cases
- [**Real-world Examples**](15-examples.md) - Complete applications
- [**Use Case Patterns**](16-use-cases.md) - Domain-specific implementations
- [**Integration Guide**](17-integration.md) - Using with other tools

### Reference
- [**API Reference**](18-api-reference.md) - Complete method documentation
- [**FAQ**](19-faq.md) - Frequently asked questions
- [**Changelog**](20-changelog.md) - Version history

## 🚀 Quick Navigation

**New to TinyRag?** Start with [Quick Start](01-quick-start.md)

**Want to jump in?** See [Basic Usage](03-basic-usage.md)

**Setting up AI chat?** Check [System Prompts](08-system-prompts.md)

**Need help?** Visit [Troubleshooting](14-troubleshooting.md)

## 💡 Key Features

- **📄 Multi-Format Support**: PDF, DOCX, CSV, TXT files
- **💻 Code Intelligence**: Function-level indexing for 7+ languages
- **🧠 Local Embeddings**: Works without API keys using all-MiniLM-L6-v2
- **🚀 Multithreading**: Parallel document processing
- **🔍 Smart Search**: Semantic similarity with relevance scoring
- **💬 Optional LLM**: Chat functionality with custom system prompts
- **⚡ Minimal Setup**: Works out of the box

## 🤝 Community

- **GitHub**: [https://github.com/Kenosis01/TinyRag](https://github.com/Kenosis01/TinyRag)
- **Issues**: [Report bugs and request features](https://github.com/Kenosis01/TinyRag/issues)
- **Discussions**: [Community discussions](https://github.com/Kenosis01/TinyRag/discussions)
- **Support**: [Buy me a coffee ☕](https://buymeacoffee.com/kenosis)

## 📝 License

TinyRag is released under the MIT License. See [LICENSE](../LICENSE) for details.

---

*Last updated: 2025*