598c1da17b
✨ Features: - Add comprehensive database service documentation - Create detailed module README with usage examples - Expand main documentation index with database links - Add component test support to Jest configuration 🔧 Improvements: - Fix AvatarDropdown test failures (dark mode classes and rapid clicking) - Update documentation version to 2.1 - Include migration guide and troubleshooting sections - Add performance considerations and security notes 📚 Documentation: - Complete API reference with code examples - Architecture overview with Strategy pattern explanation - Environment configuration and strategy selection guide - Best practices and development guidelines - Comprehensive refactoring summary 🧪 Testing: - All 292 tests passing across all modules - Component tests now properly integrated with Jest - Fixed TypeScript compatibility issues in tests - Verified database service functionality in all environments 📋 Summary: - Removed deprecated CouchDB service files - Consolidated database operations under unified service - Enhanced documentation structure and content - Improved test coverage and reliability - Maintained backward compatibility where possible
3.6 KiB
3.6 KiB
📚 Documenta#### 💻 Development
- API Documentation - REST API endpoints and usage
- Code Quality - Linting, formatting, and quality standards
- Application Security - Application security practices
- Security Changes - Recent security updates and changesndex
Welcome to the RxMinder documentation! This guide will help you navigate through all available documentation organized by category.
🏗️ Architecture & Design
- Project Structure - Complete overview of the codebase organization
- Template Approach - Design philosophy and template methodology
🚀 Setup & Configuration
- Complete Template Configuration - Full setup guide
- Setup Complete - Post-setup verification checklist
💻 Development
- API Documentation - REST API endpoints and usage
- Database Service - Database abstraction layer and strategy pattern implementation
- Code Quality - Linting, formatting, and quality standards
- Security - Security guidelines and best practices
- Security Changes - Recent security updates and changes
🚢 Deployment
- Deployment Guide - General deployment instructions
- Docker Configuration - Docker setup and configuration
- Gitea Setup - Gitea CI/CD configuration
- Storage Configuration - Database and storage setup
🔄 Migration Guides
- NodeJS Pre-commit Migration - Migration from Python to NodeJS pre-commit hooks
- Buildx Migration - Docker Buildx migration guide
📝 Project Information
- README - Main project overview and quick start
- Contributing - How to contribute to the project
- Changelog - Version history and changes
- License - Project license information
📋 Documentation Meta
- Documentation Reorganization - How we restructured the docs
- Docs Update Summary - Legacy documentation summary
🔍 Quick Navigation
For New Developers
- Start with README
- Review Project Structure
- Follow Complete Template Configuration
- Read Code Quality guidelines
For Deployment
- Read Deployment Guide
- Configure Docker
- Set up Storage
- Review Security requirements
For API Integration
- Check API Documentation
- Review Database Service for data operations
- Review Security requirements
For Migration Tasks
- NodeJS Pre-commit Migration - For modernizing git hooks
- Buildx Migration - For Docker build improvements
📋 Last Updated: January 2024
🔄 Documentation Version: 2.1
📦 Project Version: 0.0.0