# Mercury UPI PSP Platform Documentation

This directory contains all documentation for the Mercury UPI PSP Platform, organized by category for easy navigation.

## 📁 Directory Structure

```
docs/
├── api/                          # API Documentation
│   ├── API_README.md            # API overview and getting started
│   └── COMPLETE_UPI_API_DOCUMENTATION.md  # Complete API reference
├── implementation/               # Implementation Documentation
│   ├── IMPLEMENTATION_PLAN.md   # Original implementation plan
│   ├── IMPLEMENTATION_SUMMARY.md # Implementation summary
│   ├── INTERNATIONAL_REQPAY_IMPLEMENTATION.md # International payments
│   ├── PHASE_5B_REAL_PARTNERS.md # Partner integration details
│   └── UPI_PSP_IMPLEMENTATION_SUMMARY.md # UPI PSP summary
├── guides/                      # Setup and Development Guides
│   ├── CONTRIBUTING.md          # Contribution guidelines
│   ├── TESTING_GUIDE.md         # Testing procedures
│   ├── POSTMAN_COLLECTION_GUIDE.md # Postman usage guide
│   ├── PROJECT_CONFIG.md        # Project configuration
│   ├── TIDEWAVE_SETUP.md        # TideWave integration setup
│   ├── NPCI_RULES_GAP_ANALYSIS.md # NPCI compliance analysis
│   └── UPI-Specififcation-Document.md # UPI specification reference
└── README.md                    # This file
```

## 🚀 Quick Start

1. **API Development**: Start with [API_README.md](api/API_README.md)
2. **Platform Setup**: Follow [PROJECT_CONFIG.md](guides/PROJECT_CONFIG.md)
3. **Testing**: Refer to [TESTING_GUIDE.md](guides/TESTING_GUIDE.md)
4. **Contributing**: Read [CONTRIBUTING.md](guides/CONTRIBUTING.md)

## 📚 Documentation Categories

### API Documentation
- Complete API reference with examples
- Authentication and authorization guides
- Error handling and status codes

### Implementation Guides
- Phase-wise implementation details
- Architecture decisions and patterns
- Integration specifications

### Setup & Configuration
- Environment setup instructions
- Configuration management
- Third-party integrations

## 🔗 Related Resources

- **Manual Testing**: See `../manual_testing/` for test scripts and samples
- **Source Code**: Main application code in `../lib/`
- **Database**: Migration files in `../priv/repo/migrations/`

## 📞 Support

For questions or issues, please refer to the relevant documentation section or contact the development team.