# Documentation Index **Last Updated**: 2025-01-27 **Purpose**: Central navigation hub for all project documentation ## Quick Navigation 📖 **[Navigation Guide](NAVIGATION.md)** - Complete documentation navigation ## Documentation by Category ### 🚀 Getting Started - [Main README](../README.md) - Project overview and quick start - [Project Structure](../PROJECT_STRUCTURE.md) - Complete structure guide - [Quick Start Guide](../QUICKSTART.md) - Development setup ### 📐 Architecture - [Architecture Overview](architecture/README.md) - System architecture - [Cloud for Sovereignty Landing Zone](architecture/CLOUD_FOR_SOVEREIGNTY_LANDING_ZONE.md) - Complete architecture - [Sovereignty Landing Zone Summary](architecture/SOVEREIGNTY_LANDING_ZONE_SUMMARY.md) - Executive summary ### 🚢 Deployment - [Deployment Overview](deployment/README.md) - Deployment guide index - [Azure Environment Setup](deployment/azure/ENVIRONMENT_SETUP.md) - Azure configuration - [Sovereignty Landing Zone Deployment](deployment/azure/SOVEREIGNTY_LANDING_ZONE_DEPLOYMENT.md) - Multi-region deployment - [Azure CDN Setup](deployment/azure/cdn-setup.md) - CDN configuration - [Entra VerifiedID Setup](deployment/azure/entra-verifiedid.md) - Entra configuration - [Dotenv Setup](deployment/azure/DOTENV_SETUP.md) - Environment variable configuration ### 🔌 Integrations - [Integrations Overview](integrations/README.md) - Integration index - [Entra VerifiedID](integrations/entra-verifiedid/README.md) - Credential issuance guide ### ⚖️ Legal System - [Legal Documentation](legal/README.md) - Legal system overview - [Document Management](legal/document-management/) - DMS documentation - [Implementation Guide](legal/document-management/implementation/) - Implementation details ### 🏛️ Governance - [Governance Overview](governance/README.md) - Governance index - [Contributing Guidelines](governance/CONTRIBUTING.md) - How to contribute - [Security Policies](governance/SECURITY.md) - Security guidelines ### 📊 Reports & Status - [Reports Overview](reports/README.md) - Project reports index - [Comprehensive Project Review](reports/COMPREHENSIVE_PROJECT_REVIEW.md) - Full project review - [Remaining Steps](reports/REMAINING_STEPS_COMPLETE.md) - Task list - [Task Completion Status](reports/TASK_COMPLETION_STATUS.md) - Progress tracking ## Documentation by Role ### For Developers 1. Start: [README](../README.md) 2. Structure: [PROJECT_STRUCTURE.md](../PROJECT_STRUCTURE.md) 3. Architecture: [Architecture Overview](architecture/README.md) 4. Service Docs: `services/*/README.md` 5. Package Docs: `packages/*/README.md` ### For Infrastructure Engineers 1. Infrastructure: [Infrastructure README](../infra/README.md) 2. Terraform: [Terraform Guide](../infra/terraform/README.md) 3. Kubernetes: [K8s Guide](../infra/k8s/README.md) 4. Azure: [Azure Deployment Guides](deployment/azure/) ### For Security Engineers 1. Security: [Security Policies](governance/SECURITY.md) 2. Architecture: [Architecture Security](architecture/README.md#security) 3. Compliance: [Cloud for Sovereignty](architecture/CLOUD_FOR_SOVEREIGNTY_LANDING_ZONE.md) ### For Project Managers 1. Status: [Task Completion Status](reports/TASK_COMPLETION_STATUS.md) 2. Review: [Comprehensive Review](reports/COMPREHENSIVE_PROJECT_REVIEW.md) 3. Summary: [Sovereignty Landing Zone Summary](architecture/SOVEREIGNTY_LANDING_ZONE_SUMMARY.md) ## Documentation Structure ``` docs/ ├── README.md # This file ├── NAVIGATION.md # Navigation guide ├── architecture/ # Architecture documentation ├── deployment/ # Deployment guides │ └── azure/ # Azure-specific ├── integrations/ # Integration documentation ├── legal/ # Legal system documentation ├── governance/ # Governance & policies └── reports/ # Project reports ``` ## Finding Documentation ### By Topic - **Architecture**: `docs/architecture/` - **Deployment**: `docs/deployment/` - **Integrations**: `docs/integrations/` - **Legal**: `docs/legal/` - **Governance**: `docs/governance/` - **Reports**: `docs/reports/` ### By File Type - **README.md**: Directory overviews - ***_SETUP.md**: Setup guides - ***_DEPLOYMENT.md**: Deployment guides - ***_GUIDE.md**: How-to guides - ***_SUMMARY.md**: Executive summaries ## Contributing to Documentation 1. Follow existing structure 2. Use consistent naming conventions 3. Include examples and code snippets 4. Keep documentation up to date 5. Update navigation files ## Quick Links - 📖 [Complete Navigation Guide](NAVIGATION.md) - 🏗️ [Project Structure](../PROJECT_STRUCTURE.md) - 🚀 [Quick Start](../QUICKSTART.md) - 📐 [Architecture](architecture/README.md) - 🚢 [Deployment](deployment/README.md) --- **Last Updated**: 2025-01-27