e48adbcb00
- Migrated from Python pre-commit to NodeJS-native solution - Reorganized documentation structure - Set up Husky + lint-staged for efficient pre-commit hooks - Fixed Dockerfile healthcheck issue - Added comprehensive documentation index
82 lines
3.5 KiB
Markdown
82 lines
3.5 KiB
Markdown
# 📚 Documenta#### 💻 Development
|
|
|
|
- **[API Documentation](development/API.md)** - REST API endpoints and usage
|
|
- **[Code Quality](development/CODE_QUALITY.md)** - Linting, formatting, and quality standards
|
|
- **[Application Security](development/APPLICATION_SECURITY.md)** - Application security practices
|
|
- **[Security Changes](development/SECURITY_CHANGES.md)** - 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](architecture/PROJECT_STRUCTURE.md)** - Complete overview of the codebase organization
|
|
- **[Template Approach](architecture/TEMPLATE_APPROACH.md)** - Design philosophy and template methodology
|
|
|
|
## 🚀 Setup & Configuration
|
|
|
|
- **[Complete Template Configuration](setup/COMPLETE_TEMPLATE_CONFIGURATION.md)** - Full setup guide
|
|
- **[Setup Complete](setup/SETUP_COMPLETE.md)** - Post-setup verification checklist
|
|
|
|
## 💻 Development
|
|
|
|
- **[API Documentation](development/API.md)** - REST API endpoints and usage
|
|
- **[Code Quality](development/CODE_QUALITY.md)** - Linting, formatting, and quality standards
|
|
- **[Security](development/SECURITY.md)** - Security guidelines and best practices
|
|
- **[Security Changes](development/SECURITY_CHANGES.md)** - Recent security updates and changes
|
|
|
|
## 🚢 Deployment
|
|
|
|
- **[Deployment Guide](deployment/DEPLOYMENT.md)** - General deployment instructions
|
|
- **[Docker Configuration](deployment/DOCKER_IMAGE_CONFIGURATION.md)** - Docker setup and configuration
|
|
- **[Gitea Setup](deployment/GITEA_SETUP.md)** - Gitea CI/CD configuration
|
|
- **[Storage Configuration](deployment/STORAGE_CONFIGURATION.md)** - Database and storage setup
|
|
|
|
## 🔄 Migration Guides
|
|
|
|
- **[NodeJS Pre-commit Migration](migration/NODEJS_PRECOMMIT_MIGRATION.md)** - Migration from Python to NodeJS pre-commit hooks
|
|
- **[Buildx Migration](migration/BUILDX_MIGRATION.md)** - Docker Buildx migration guide
|
|
|
|
## 📝 Project Information
|
|
|
|
- **[README](../README.md)** - Main project overview and quick start
|
|
- **[Contributing](../CONTRIBUTING.md)** - How to contribute to the project
|
|
- **[Changelog](../CHANGELOG.md)** - Version history and changes
|
|
- **[License](../LICENSE)** - Project license information
|
|
|
|
## 📋 Documentation Meta
|
|
|
|
- **[Documentation Reorganization](REORGANIZATION_SUMMARY.md)** - How we restructured the docs
|
|
- **[Docs Update Summary](DOCS_UPDATE_SUMMARY.md)** - Legacy documentation summary
|
|
|
|
## 🔍 Quick Navigation
|
|
|
|
### For New Developers
|
|
|
|
1. Start with [README](../README.md)
|
|
2. Review [Project Structure](architecture/PROJECT_STRUCTURE.md)
|
|
3. Follow [Complete Template Configuration](setup/COMPLETE_TEMPLATE_CONFIGURATION.md)
|
|
4. Read [Code Quality](development/CODE_QUALITY.md) guidelines
|
|
|
|
### For Deployment
|
|
|
|
1. Read [Deployment Guide](deployment/DEPLOYMENT.md)
|
|
2. Configure [Docker](deployment/DOCKER_IMAGE_CONFIGURATION.md)
|
|
3. Set up [Storage](deployment/STORAGE_CONFIGURATION.md)
|
|
4. Review [Security](development/SECURITY.md) requirements
|
|
|
|
### For API Integration
|
|
|
|
1. Check [API Documentation](development/API.md)
|
|
2. Review [Security](development/SECURITY.md) requirements
|
|
|
|
### For Migration Tasks
|
|
|
|
1. [NodeJS Pre-commit Migration](migration/NODEJS_PRECOMMIT_MIGRATION.md) - For modernizing git hooks
|
|
2. [Buildx Migration](migration/BUILDX_MIGRATION.md) - For Docker build improvements
|
|
|
|
---
|
|
|
|
📋 **Last Updated:** September 6, 2025
|
|
🔄 **Documentation Version:** 2.0
|
|
📦 **Project Version:** 0.0.0
|