92 lines
2.1 KiB
Markdown
92 lines
2.1 KiB
Markdown
# 📚 Documentation Reference
|
|
|
|
## Main Documentation (Root)
|
|
|
|
Keep these files in the root directory:
|
|
|
|
### Core Docs
|
|
- **README.md** - Main documentation entry point
|
|
- **QUICK_START.md** - Getting started guide
|
|
- **DEPLOYMENT.md** - Complete deployment guide
|
|
- **TROUBLESHOOTING.md** - Common issues and fixes
|
|
|
|
### Reference Docs
|
|
- **PM2_PRODUCTION_GUIDE.md** - Detailed PM2 documentation
|
|
- **QUICK_REFERENCE.md** - Quick command reference
|
|
|
|
---
|
|
|
|
## Scripts
|
|
|
|
All deployment scripts are in `scripts/` folder:
|
|
|
|
- **deploy.sh** - Unified deployment script
|
|
- **diagnose.sh** - Full system diagnostics
|
|
- **backup-db.sh** - Database backup
|
|
- **restore-db.sh** - Database restore
|
|
- **fix-502.sh** - Auto-fix 502 errors
|
|
|
|
---
|
|
|
|
## Backend Docs
|
|
|
|
Keep in `backend/` folder:
|
|
|
|
- **README.md** - Backend documentation
|
|
- **API_DOCUMENTATION.md** - API endpoints reference
|
|
- **WHATSAPP_AND_REMINDERS_IMPLEMENTATION_STATUS.md** - WhatsApp features
|
|
- **WHATSAPP_USAGE_EXAMPLES.md** - WhatsApp usage
|
|
|
|
---
|
|
|
|
## Frontend Docs
|
|
|
|
Keep in `luckychit/` folder:
|
|
|
|
- **README.md** - Frontend documentation
|
|
- Various feature implementation docs
|
|
|
|
---
|
|
|
|
## Old Files
|
|
|
|
All old/redundant files have been moved to `old_docs_backup_*/`
|
|
|
|
You can safely delete the backup folder after confirming everything works:
|
|
```bash
|
|
rm -rf old_docs_backup_*
|
|
```
|
|
|
|
---
|
|
|
|
## Documentation Structure (Final)
|
|
|
|
```
|
|
chitfund/
|
|
├── README.md # Main docs
|
|
├── QUICK_START.md # Getting started
|
|
├── DEPLOYMENT.md # Deployment guide
|
|
├── TROUBLESHOOTING.md # Troubleshooting
|
|
├── PM2_PRODUCTION_GUIDE.md # Detailed PM2 docs
|
|
├── QUICK_REFERENCE.md # Quick reference
|
|
│
|
|
├── scripts/ # All scripts here
|
|
│ ├── deploy.sh
|
|
│ ├── diagnose.sh
|
|
│ ├── backup-db.sh
|
|
│ ├── restore-db.sh
|
|
│ └── fix-502.sh
|
|
│
|
|
├── backend/ # Backend
|
|
│ ├── README.md
|
|
│ └── API_DOCUMENTATION.md
|
|
│
|
|
└── luckychit/ # Frontend
|
|
└── README.md
|
|
```
|
|
|
|
---
|
|
|
|
**Clean, organized, and easy to maintain!** 🎉
|
|
|