readur/docs/dev

Developer Documentation

This directory contains technical documentation for developers working on Readur.

📋 Table of Contents

🏗️ Architecture & Design

• Architecture Overview - System design, components, and data flow
• Database Guardrails - Concurrency safety and database best practices
• Storage Architecture - S3 and local storage backend implementation

🛠️ Development

• Development Guide - Setup, contributing, code style guidelines
• Testing Guide - Comprehensive testing strategy and instructions

⚙️ Technical Guides

• OCR Optimization - Performance tuning and best practices
• Queue Improvements - Background job processing architecture
• Deployment Summary - Technical deployment overview
• Migration Guide - Storage migration procedures
• S3 Troubleshooting - Debugging S3 storage issues

🚀 Quick Start for Developers

1. Read the Architecture Overview to understand the system design
2. Follow the Development Guide to set up your local environment
3. Review the Testing Guide to understand our testing approach
4. Check Database Guardrails for data safety patterns

📖 Related User Documentation

• Installation Guide - How to install and run Readur
• Configuration Guide - Environment variables and settings
• Configuration Reference - Complete configuration options
• User Guide - How to use Readur features
• API Reference - REST API documentation

🤝 Contributing

Please read our Development Guide 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