📚 Complete Documentation Index
Quick Start (5 minutes)
New to the project? Start here:
- QUICK_REFERENCE.md - One-page overview of all features
Feature Documentation
Learn what the application can do:
- FEATURES.md - Complete feature guide with examples
- Authentication system overview
- Chat history persistence
- Role-based access control
- Visualization dashboard
- Production recommendations
Deployment Guides
For Azure Deployment (Recommended - 30 minutes)
- PRODUCTION_QUICKSTART.md - Step-by-step Azure deployment
- Set up Azure resources
- Configure secrets
- Build and push Docker image
- Deploy to Azure Container Instances
For All Deployment Platforms (Comprehensive)
- PRODUCTION_DEPLOYMENT.md - Complete deployment reference
- Multiple platform options (Azure, Docker, K8s, Heroku, On-premises)
- HTTPS/SSL configuration
- Monitoring & logging
- Backup & recovery
- Production security checklist
- Troubleshooting guide
For General Deployment Information
- DEPLOYMENT.md - Original deployment guide
- General setup instructions
- Docker and cloud options
- Security considerations
Project Information
Understanding the Project
- README.md - Project mission and background
- The Open Nursing Core (ONC) initiative
- Acknowledgments and leadership
- Licensing information
Progress Tracking
- PHASE1_COMPLETE.md - Phase 1 completion report
- What was accomplished
- Code metrics
- Next phase recommendations
File Organization
open-nursing-core-ig/
├── 📄 Documentation
│ ├── README.md ← Project overview
│ ├── QUICK_REFERENCE.md ← Start here (5 min read)
│ ├── FEATURES.md ← Feature documentation
│ ├── DEPLOYMENT.md ← General deployment
│ ├── PRODUCTION_QUICKSTART.md ← Azure in 30 min
│ ├── PRODUCTION_DEPLOYMENT.md ← All platforms (900+ lines)
│ ├── PHASE1_COMPLETE.md ← Completion report
│ └── INDEX.md ← This file
│
├── 🐍 Python Application
│ ├── app.py ← Main Streamlit application
│ ├── visualizations.py ← Visualization components
│ ├── harvest_fons.py ← Download FoNS articles
│ └── ingest_fast.py ← Build knowledge database
│
├── 🐳 Docker & Deployment
│ ├── Dockerfile ← Production multi-stage build
│ ├── docker-compose.yml ← Local testing environment
│ └── .env.production.example ← Configuration template
│
├── 🔧 Configuration
│ ├── requirements.txt ← Python dependencies
│ ├── ig.ini ← FHIR configuration
│ ├── sushi-config.yaml ← SUSHI compiler config
│ └── .gitignore ← Git exclusions
│
├── 📊 GitHub Actions
│ ├── .github/workflows/publish.yaml ← Build & publish IG
│ └── .github/workflows/production-deploy.yml ← CI/CD pipeline
│
└── 📁 Data Directories
├── chroma_db_fons/ ← Knowledge database
├── fons_knowledge_base/ ← FoNS articles
├── docs/ ← Generated documentation
├── input/ ← FHIR input files
└── output/ ← Generated outputs
Which File Should I Read?
"I just want to get started quickly"
→ Read: QUICK_REFERENCE.md (5 minutes)
"I want to understand all the features"
→ Read: FEATURES.md (15 minutes)
"I want to deploy to Azure right now"
→ Read: PRODUCTION_QUICKSTART.md (30 minutes)
"I need a complete deployment reference"
→ Read: PRODUCTION_DEPLOYMENT.md (comprehensive)
"I'm deploying on a specific platform"
→ Search for your platform in PRODUCTION_DEPLOYMENT.md:
- Azure Container Instances
- Azure App Service
- Kubernetes (AKS)
- Docker Compose
- Heroku
- On-premises servers
"I need to understand the architecture"
→ Read: PHASE1_COMPLETE.md (architecture section)
"I want to know about security"
→ Search "Security" in PRODUCTION_DEPLOYMENT.md
Key Documentation Highlights
Authentication & Security
- Multi-user login system
- 3 user roles (Nurse, Clinician, Admin)
- Role-based access control
- Chat history per user
- Session management
- Production security checklist
Features
- Interactive chat with AI
- 5-tab dashboard with visualizations
- Care plan tracking
- Problem assessment
- Intervention analysis
- Health indicators
- Chat export functionality
Deployment Options
- Azure (Recommended - easiest)
- Docker Compose (local testing)
- Kubernetes (enterprise scale)
- Heroku (simplest alternative)
- On-premises (full control)
Code Quality
- PEP 8 compliant
- Production logging
- Error handling
- Input validation
- Security scanning
- Automated testing
Getting Help
Have a question?
- Check the relevant documentation file above
- Search GitHub Issues: https://github.com/ClinyQAi/open-nursing-core-ig/issues
- Check Discussions: https://github.com/ClinyQAi/open-nursing-core-ig/discussions
Found a bug?
- Open a GitHub Issue with details
- Check troubleshooting sections in relevant docs
Want to contribute?
- Review the code structure
- Check existing issues/PRs
- Follow Python PEP 8 standards
- Add tests for new features
Project Status
Current Version: 2.0.0
Status: Phase 1 Complete ✅
Release Date: November 29, 2025
What's Implemented
- ✅ Authentication system
- ✅ Chat history persistence
- ✅ Role-based access control
- ✅ Interactive visualizations
- ✅ Production-ready code
- ✅ Docker/container support
- ✅ CI/CD pipeline
- ✅ Comprehensive documentation
What's Next (Phase 2)
- Database integration (PostgreSQL)
- Advanced analytics
- EHR integration
- Mobile app (React Native)
Quick Links
GitHub Repository: https://github.com/ClinyQAi/open-nursing-core-ig
Live Documentation: https://clinyqai.github.io/open-nursing-core-ig/
Issues & Discussions: https://github.com/ClinyQAi/open-nursing-core-ig/issues
📞 Support
For issues or questions:
- Check the documentation
- Search existing GitHub issues
- Open a new issue with details
- Join discussions for feature requests
Last Updated: November 29, 2025
Maintainer: ClinyQAi Team
License: MIT