the_order/docs/NAVIGATION.md

Documentation Navigation Guide

Last Updated: 2025-01-27
Purpose: Quick navigation guide for all project documentation

Quick Links

🚀 Getting Started

• Main README - Project overview
• 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 - Entra setup

🔌 Integrations

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

⚖️ Legal System

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

🏛️ Governance

• Governance Overview - Governance index
• Contributing - Contribution guidelines
• Security - Security policies

📊 Reports

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

Documentation by Role

👨‍💻 Developers

Getting Started

1. README
2. Project Structure
3. Quick Start

Backend Development

• Architecture
• Service READMEs in services/*/README.md
• Package READMEs in packages/*/README.md

Frontend Development

• Architecture
• App READMEs in apps/*/README.md
• UI Package

🏗️ Infrastructure Engineers

Infrastructure

1. Infrastructure README
2. Terraform Guide
3. Kubernetes Guide

Azure Deployment

1. Environment Setup
2. Sovereignty Landing Zone
3. CDN Setup

Cloud Architecture

1. Cloud for Sovereignty Landing Zone
2. Well-Architected Framework

🔐 Security Engineers

Security

1. Security Policies
2. Architecture Security
3. Compliance

Compliance

1. Cloud for Sovereignty
2. GDPR Compliance
3. eIDAS Compliance

📋 Project Managers

Project Status

1. Task Completion Status
2. Comprehensive Review
3. Remaining Steps

Architecture

1. Sovereignty Landing Zone Summary
2. Architecture Overview

Documentation Structure

docs/
├── README.md                    # This file
├── architecture/                 # Architecture documentation
│   ├── README.md                # Architecture overview
│   ├── CLOUD_FOR_SOVEREIGNTY_LANDING_ZONE.md
│   └── SOVEREIGNTY_LANDING_ZONE_SUMMARY.md
├── deployment/                   # Deployment guides
│   ├── README.md                # Deployment index
│   └── azure/                   # Azure-specific guides
│       ├── ENVIRONMENT_SETUP.md
│       ├── SOVEREIGNTY_LANDING_ZONE_DEPLOYMENT.md
│       ├── DOTENV_SETUP.md
│       ├── cdn-setup.md
│       └── entra-verifiedid.md
├── integrations/                 # Integration documentation
│   ├── README.md                # Integration index
│   └── entra-verifiedid/       # Entra VerifiedID
│       └── README.md
├── legal/                        # Legal system documentation
│   ├── README.md                # Legal system overview
│   └── document-management/     # Document management
│       └── implementation/      # Implementation details
├── governance/                   # Governance & policies
│   ├── README.md                # Governance overview
│   ├── CONTRIBUTING.md
│   └── SECURITY.md
└── reports/                      # Project reports
    ├── README.md                # Reports index
    ├── COMPREHENSIVE_PROJECT_REVIEW.md
    ├── REMAINING_STEPS_COMPLETE.md
    └── TASK_COMPLETION_STATUS.md

Finding Documentation

By Topic

Architecture

• All files in docs/architecture/

Deployment

• All files in docs/deployment/

Integrations

• All files in docs/integrations/

Legal System

• All files in docs/legal/

Governance

• All files in docs/governance/

Reports

• All files in docs/reports/

By File Type

README Files - Directory overviews

find docs -name README.md

Guides - How-to guides

find docs -name "*GUIDE*.md"
find docs -name "*SETUP*.md"

Architecture - Architecture documentation

find docs -name "*ARCHITECTURE*.md"
find docs -name "*LANDING*.md"

Reports - Status reports

find docs -name "*REPORT*.md"
find docs -name "*STATUS*.md"
find docs -name "*REVIEW*.md"

Documentation Standards

File Naming

• README.md - Directory overview
• *_SETUP.md - Setup guides
• *_DEPLOYMENT.md - Deployment guides
• *_GUIDE.md - How-to guides
• *_SUMMARY.md - Executive summaries
• *_REVIEW.md - Reviews and analysis

Structure

• Overview - What is this?
• Prerequisites - What do I need?
• Quick Start - How do I start?
• Detailed Guide - Step-by-step instructions
• Troubleshooting - Common issues
• References - Additional resources

Contributing to Documentation

1. Follow existing structure
2. Use consistent naming
3. Include examples
4. Keep it up to date
5. Add to navigation (this file)

---

Last Updated: 2025-01-27