115 lines
3.1 KiB
Markdown
115 lines
3.1 KiB
Markdown
# Documentation Index
|
|
|
|
Quick reference to find what you need.
|
|
|
|
---
|
|
|
|
## 📚 Main Documentation
|
|
|
|
### Getting Started
|
|
- **[README.md](./README.md)** - Project overview and quick start
|
|
- **[CHANGELOG.md](./CHANGELOG.md)** - Version history and updates
|
|
|
|
### For Managers/Admins
|
|
- **[ADMIN_GUIDE.md](./ADMIN_GUIDE.md)** - Complete admin features guide
|
|
- Edit/delete draws
|
|
- Edit/delete groups
|
|
- Edit members
|
|
- Member numbers explained
|
|
- Visual examples
|
|
|
|
### Technical Documentation
|
|
- **[backend/API_DOCUMENTATION.md](./backend/API_DOCUMENTATION.md)** - All API endpoints
|
|
- **[DEPLOYMENT.md](./DEPLOYMENT.md)** - Production deployment guide
|
|
- **[backend/TROUBLESHOOTING.md](./backend/TROUBLESHOOTING.md)** - Fix common issues
|
|
|
|
### Feature-Specific Guides
|
|
- **[HOW_TO_ADD_PAST_DRAWS.md](./HOW_TO_ADD_PAST_DRAWS.md)** - Import historical draws
|
|
- **[backend/WHATSAPP_USAGE_EXAMPLES.md](./backend/WHATSAPP_USAGE_EXAMPLES.md)** - WhatsApp features
|
|
|
|
---
|
|
|
|
## 🗂️ Documentation Structure
|
|
|
|
```
|
|
Project Root
|
|
├── README.md # Main project README
|
|
├── ADMIN_GUIDE.md # All admin features
|
|
├── DEPLOYMENT.md # Deployment instructions
|
|
├── CHANGELOG.md # Version history
|
|
├── DOCUMENTATION_INDEX.md # This file
|
|
├── TROUBLESHOOTING.md # General troubleshooting
|
|
├── HOW_TO_ADD_PAST_DRAWS.md # Feature guide
|
|
│
|
|
├── backend/
|
|
│ ├── README.md # Backend setup
|
|
│ ├── API_DOCUMENTATION.md # API reference
|
|
│ ├── TROUBLESHOOTING.md # Backend issues
|
|
│ ├── WHATSAPP_USAGE_EXAMPLES.md # WhatsApp guide
|
|
│ ├── run-member-number-migration.js # Migration script
|
|
│ └── migrations/
|
|
│ └── 20251106_add_member_number.sql
|
|
│
|
|
└── luckychit/
|
|
└── README.md # Flutter app info
|
|
```
|
|
|
|
---
|
|
|
|
## 🎯 Quick Links by Task
|
|
|
|
### I want to...
|
|
|
|
**Setup the project**
|
|
→ [README.md](./README.md) → Quick Start section
|
|
|
|
**Deploy to production**
|
|
→ [DEPLOYMENT.md](./DEPLOYMENT.md)
|
|
|
|
**Use admin features**
|
|
→ [ADMIN_GUIDE.md](./ADMIN_GUIDE.md)
|
|
|
|
**Fix an error**
|
|
→ [backend/TROUBLESHOOTING.md](./backend/TROUBLESHOOTING.md)
|
|
|
|
**Import old data**
|
|
→ [HOW_TO_ADD_PAST_DRAWS.md](./HOW_TO_ADD_PAST_DRAWS.md)
|
|
|
|
**Use the API**
|
|
→ [backend/API_DOCUMENTATION.md](./backend/API_DOCUMENTATION.md)
|
|
|
|
**See what's new**
|
|
→ [CHANGELOG.md](./CHANGELOG.md)
|
|
|
|
---
|
|
|
|
## 📖 Documentation Standards
|
|
|
|
### File Naming
|
|
- **UPPERCASE.md** - Important docs (README, CHANGELOG)
|
|
- **PascalCase.md** - Feature guides
|
|
- **lowercase.md** - Technical/internal docs
|
|
|
|
### Location
|
|
- **Root** - Project-wide documentation
|
|
- **backend/** - Backend-specific docs
|
|
- **luckychit/** - Flutter app docs
|
|
- **docs/** - Archive/additional docs
|
|
|
|
---
|
|
|
|
## ✅ Documentation Status
|
|
|
|
- [x] Main README created
|
|
- [x] Admin guide consolidated
|
|
- [x] Deployment guide complete
|
|
- [x] API documentation updated
|
|
- [x] Troubleshooting guides merged
|
|
- [x] Redundant files removed
|
|
- [x] Clean structure established
|
|
|
|
---
|
|
|
|
**All documentation is now organized and easy to find!** 📚✨
|
|
|