280eb489e7
- Remove references to deleted migration and deployment documents - Update file paths to reflect new organization structure - Simplify navigation sections to focus on current development needs - Remove broken links and obsolete sections - Update documentation version to 3.0 to reflect major reorganization
66 lines
2.8 KiB
Markdown
66 lines
2.8 KiB
Markdown
# 📚 Documentation Index
|
|
|
|
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
|
|
- **[Environment Variables](setup/ENVIRONMENT_VARIABLES.md)** - Environment configuration guide
|
|
- **[App Name Configuration](setup/APP_NAME_CONFIGURATION.md)** - Customizing application branding
|
|
|
|
## 💻 Development
|
|
|
|
- **[API Documentation](development/API.md)** - REST API endpoints and usage
|
|
- **[Database Service](development/DATABASE.md)** - Database abstraction layer and strategy pattern implementation
|
|
- **[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 changes
|
|
- **[Pre-commit Hooks](development/PRE_COMMIT_HOOKS.md)** - Git hook configuration and usage
|
|
|
|
## 🔧 Implementation
|
|
|
|
- **[Implementation Summary](implementation/IMPLEMENTATION_SUMMARY.md)** - Current implementation status and features
|
|
|
|
## 📝 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
|
|
|
|
## 🔍 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
|
|
5. Set up [Pre-commit Hooks](development/PRE_COMMIT_HOOKS.md)
|
|
|
|
### For Development
|
|
|
|
1. Check [API Documentation](development/API.md)
|
|
2. Review [Database Service](development/DATABASE.md) for data operations
|
|
3. Review [Application Security](development/APPLICATION_SECURITY.md) requirements
|
|
4. Configure [App Name](setup/APP_NAME_CONFIGURATION.md) for branding
|
|
5. Set up [Environment Variables](setup/ENVIRONMENT_VARIABLES.md)
|
|
|
|
### For Code Quality
|
|
|
|
1. Read [Code Quality](development/CODE_QUALITY.md) standards
|
|
2. Configure [Pre-commit Hooks](development/PRE_COMMIT_HOOKS.md)
|
|
3. Review [Security Changes](development/SECURITY_CHANGES.md)
|
|
|
|
---
|
|
|
|
📋 **Last Updated:** January 2024
|
|
🔄 **Documentation Version:** 3.0
|
|
📦 **Project Version:** 0.0.0
|