# Developer Documentation

This directory contains technical documentation for developers working on Readur.

## 📋 Table of Contents

### 🏗️ Architecture & Design
- [**Architecture Overview**](architecture.md) - System design, components, and data flow
- [**Database Guardrails**](DATABASE_GUARDRAILS.md) - Concurrency safety and database best practices
- [**Storage Architecture**](../s3-storage-guide.md) - S3 and local storage backend implementation

### 🛠️ Development
- [**Development Guide**](development.md) - Setup, contributing, code style guidelines
- [**Testing Guide**](TESTING.md) - Comprehensive testing strategy and instructions

### ⚙️ Technical Guides
- [**OCR Optimization**](OCR_OPTIMIZATION_GUIDE.md) - Performance tuning and best practices
- [**Queue Improvements**](QUEUE_IMPROVEMENTS.md) - Background job processing architecture
- [**Deployment Summary**](DEPLOYMENT_SUMMARY.md) - Technical deployment overview
- [**Migration Guide**](../migration-guide.md) - Storage migration procedures
- [**S3 Troubleshooting**](../s3-troubleshooting.md) - Debugging S3 storage issues

## 🚀 Quick Start for Developers

1. **Read the [Architecture Overview](architecture.md)** to understand the system design
2. **Follow the [Development Guide](development.md)** to set up your local environment
3. **Review the [Testing Guide](TESTING.md)** to understand our testing approach
4. **Check [Database Guardrails](DATABASE_GUARDRAILS.md)** for data safety patterns

## 📖 Related User Documentation

- [Installation Guide](../installation.md) - How to install and run Readur
- [Configuration Guide](../configuration.md) - Environment variables and settings
- [Configuration Reference](../configuration-reference.md) - Complete configuration options
- [User Guide](../user-guide.md) - How to use Readur features
- [API Reference](../api-reference.md) - REST API documentation

## 🤝 Contributing

Please read our [Development Guide](development.md) for:
- Setting up your development environment
- Code style guidelines
- Testing requirements
- Pull request process

## 🏷️ Document Categories

- **📘 User Docs**  
  Installation, configuration, user guide
  
- **🔧 Operations**  
  Deployment, monitoring, troubleshooting
  
- **💻 Developer**  
  Architecture, development setup, testing
  
- **🔌 Integration**  
  API reference, webhooks, extensions