the_order/docs

Documentation Index

Last Updated: 2025-01-27
Purpose: Central navigation hub for all project documentation

Quick Navigation

📖 Navigation Guide - Complete documentation navigation

Documentation by Category

🚀 Getting Started

• Main README - Project overview and quick start
• Project Structure - Complete structure guide
• Quick Start Guide - Development setup

📐 Architecture

• Architecture Overview - System architecture
• Cloud for Sovereignty Landing Zone - Complete architecture
• Sovereignty Landing Zone Summary - Executive summary

🚢 Deployment

• Deployment Overview - Deployment guide index
• Azure Environment Setup - Azure configuration
• Sovereignty Landing Zone Deployment - Multi-region deployment
• Azure CDN Setup - CDN configuration
• Entra VerifiedID Setup - Entra configuration
• Dotenv Setup - Environment variable configuration

🔌 Integrations

• Integrations Overview - Integration index
• Entra VerifiedID - Credential issuance guide

⚖️ Legal System

• Legal Documentation - Legal system overview
• Document Management - DMS documentation
• Implementation Guide - Implementation details

🏛️ Governance

• Governance Overview - Governance index
• Contributing Guidelines - How to contribute
• Security Policies - Security guidelines

📊 Reports & Status

• Reports Overview - Project reports index
• Comprehensive Project Review - Full project review
• Remaining Steps - Task list
• Task Completion Status - Progress tracking

Documentation by Role

For Developers

1. Start: README
2. Structure: PROJECT_STRUCTURE.md
3. Architecture: Architecture Overview
4. Service Docs: services/*/README.md
5. Package Docs: packages/*/README.md

For Infrastructure Engineers

1. Infrastructure: Infrastructure README
2. Terraform: Terraform Guide
3. Kubernetes: K8s Guide
4. Azure: Azure Deployment Guides

For Security Engineers

1. Security: Security Policies
2. Architecture: Architecture Security
3. Compliance: Cloud for Sovereignty

For Project Managers

1. Status: Task Completion Status
2. Review: Comprehensive Review
3. Summary: Sovereignty Landing Zone Summary

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
• 🏗️ Project Structure
• 🚀 Quick Start
• 📐 Architecture
• 🚢 Deployment

---

Last Updated: 2025-01-27