|
| 1 | +# CureOS Documentation Index |
| 2 | + |
| 3 | +Welcome to CureOS Hospital Management System documentation. This guide will help you navigate all available resources. |
| 4 | + |
| 5 | +## 📚 Quick Navigation |
| 6 | + |
| 7 | +### 🚀 Getting Started |
| 8 | +- [Quick Start Guide](./guides/01-quick-start.md) - 5-minute setup and first login |
| 9 | +- [Installation Guide](./guides/02-installation.md) - Complete setup instructions |
| 10 | +- [System Overview](./guides/03-system-overview.md) - Architecture and features |
| 11 | + |
| 12 | +### 🔐 Security & RBAC |
| 13 | +- [RBAC Architecture](./architecture/01-rbac-architecture.md) - System design and flow |
| 14 | +- [Security Implementation](./security/01-security-implementation.md) - All security measures |
| 15 | +- [Authentication Flow](./security/02-authentication-flow.md) - Login and token handling |
| 16 | +- [Admin Operations](./security/03-admin-operations.md) - Safe admin procedures |
| 17 | + |
| 18 | +### 🛠️ Development |
| 19 | +- [Implementation Details](./architecture/02-implementation-details.md) - Code structure |
| 20 | +- [API Endpoints](./guides/04-api-endpoints.md) - Complete API reference |
| 21 | +- [UI Components](./guides/05-ui-components.md) - Component documentation |
| 22 | +- [Custom Hooks](./guides/06-custom-hooks.md) - React hooks reference |
| 23 | + |
| 24 | +### 📋 Deployment |
| 25 | +- [Deployment Checklist](./deployment/01-checklist.md) - Pre-production verification |
| 26 | +- [Neon Setup](./deployment/02-neon-setup.md) - PostgreSQL on Neon |
| 27 | +- [Environment Variables](./deployment/03-environment-setup.md) - Configuration guide |
| 28 | +- [Troubleshooting](./deployment/04-troubleshooting.md) - Common issues and fixes |
| 29 | + |
| 30 | +### 📊 Summaries & References |
| 31 | +- [Implementation Summary](./guides/07-implementation-summary.md) - What was built |
| 32 | +- [Feature Showcase](./guides/08-feature-showcase.md) - System capabilities |
| 33 | +- [Delivery Summary](./guides/09-delivery-summary.md) - Project completion status |
| 34 | + |
| 35 | +--- |
| 36 | + |
| 37 | +## 📖 Documentation Structure |
| 38 | + |
| 39 | +``` |
| 40 | +docs/ |
| 41 | +├── INDEX.md (this file) |
| 42 | +├── guides/ # How-to guides and references |
| 43 | +├── architecture/ # System design and technical details |
| 44 | +├── security/ # Security-related documentation |
| 45 | +└── deployment/ # Deployment and production setup |
| 46 | +``` |
| 47 | + |
| 48 | +## 🎯 Start Here |
| 49 | + |
| 50 | +**New to CureOS?** |
| 51 | +→ Start with [Quick Start Guide](./guides/01-quick-start.md) |
| 52 | + |
| 53 | +**Setting up for production?** |
| 54 | +→ Read [Deployment Checklist](./deployment/01-checklist.md) |
| 55 | + |
| 56 | +**Want to understand the system?** |
| 57 | +→ Check [RBAC Architecture](./architecture/01-rbac-architecture.md) |
| 58 | + |
| 59 | +**Need API details?** |
| 60 | +→ See [API Endpoints](./guides/04-api-endpoints.md) |
| 61 | + |
| 62 | +--- |
| 63 | + |
| 64 | +## 🔗 Key Resources |
| 65 | + |
| 66 | +| Resource | Purpose | Audience | |
| 67 | +|----------|---------|----------| |
| 68 | +| Quick Start | Get running in 5 minutes | Everyone | |
| 69 | +| Architecture | Understand system design | Developers | |
| 70 | +| Security | Learn protection measures | Security team | |
| 71 | +| API Docs | Integrate with backend | Developers | |
| 72 | +| Deployment | Prepare for production | DevOps/Admins | |
| 73 | + |
| 74 | +--- |
| 75 | + |
| 76 | +## 📞 Support |
| 77 | + |
| 78 | +For issues or questions: |
| 79 | +1. Check [Troubleshooting](./deployment/04-troubleshooting.md) first |
| 80 | +2. Review relevant section above |
| 81 | +3. Check inline code comments in source files |
| 82 | + |
| 83 | +--- |
| 84 | + |
| 85 | +**Last Updated:** January 23, 2026 |
| 86 | +**Version:** 1.0 |
| 87 | +**Status:** Production Ready ✅ |
0 commit comments