218 lines
7.0 KiB
Markdown
218 lines
7.0 KiB
Markdown
|
# Documentation Navigation Guide
|
||
|
|
|
||
|
|
**Last Updated**: 2025-01-27
|
||
|
|
**Purpose**: Quick navigation guide for all project documentation
|
||
|
|
|
||
|
|
## Quick Links
|
||
|
|
|
||
|
|
### 🚀 Getting Started
|
||
|
|
- [Main README](../README.md) - Project overview
|
||
|
|
- [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](deployment/azure/entra-verifiedid.md) - Entra setup
|
||
|
|
|
||
|
|
### 🔌 Integrations
|
||
|
|
- [Integrations Overview](integrations/README.md) - Integration index
|
||
|
|
- [Entra VerifiedID](integrations/entra-verifiedid/README.md) - Credential issuance
|
||
|
|
- [Microsoft Entra VerifiedID](integrations/entra-verifiedid/README.md) - Complete 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](governance/CONTRIBUTING.md) - Contribution guidelines
|
||
|
|
- [Security](governance/SECURITY.md) - Security policies
|
||
|
|
|
||
|
|
### 📊 Reports
|
||
|
|
- [Reports Overview](reports/README.md) - Project reports index
|
||
|
|
- [Comprehensive Project Review](reports/COMPREHENSIVE_PROJECT_REVIEW.md) - Full review
|
||
|
|
- [Remaining Steps](reports/REMAINING_STEPS_COMPLETE.md) - Task list
|
||
|
|
- [Task Completion Status](reports/TASK_COMPLETION_STATUS.md) - Progress tracking
|
||
|
|
|
||
|
|
## Documentation by Role
|
||
|
|
|
||
|
|
### 👨💻 Developers
|
||
|
|
|
||
|
|
**Getting Started**
|
||
|
|
1. [README](../README.md)
|
||
|
|
2. [Project Structure](../PROJECT_STRUCTURE.md)
|
||
|
|
3. [Quick Start](../QUICKSTART.md)
|
||
|
|
|
||
|
|
**Backend Development**
|
||
|
|
- [Architecture](architecture/README.md)
|
||
|
|
- Service READMEs in `services/*/README.md`
|
||
|
|
- Package READMEs in `packages/*/README.md`
|
||
|
|
|
||
|
|
**Frontend Development**
|
||
|
|
- [Architecture](architecture/README.md)
|
||
|
|
- App READMEs in `apps/*/README.md`
|
||
|
|
- [UI Package](../packages/ui/README.md)
|
||
|
|
|
||
|
|
### 🏗️ Infrastructure Engineers
|
||
|
|
|
||
|
|
**Infrastructure**
|
||
|
|
1. [Infrastructure README](../infra/README.md)
|
||
|
|
2. [Terraform Guide](../infra/terraform/README.md)
|
||
|
|
3. [Kubernetes Guide](../infra/k8s/README.md)
|
||
|
|
|
||
|
|
**Azure Deployment**
|
||
|
|
1. [Environment Setup](deployment/azure/ENVIRONMENT_SETUP.md)
|
||
|
|
2. [Sovereignty Landing Zone](deployment/azure/SOVEREIGNTY_LANDING_ZONE_DEPLOYMENT.md)
|
||
|
|
3. [CDN Setup](deployment/azure/cdn-setup.md)
|
||
|
|
|
||
|
|
**Cloud Architecture**
|
||
|
|
1. [Cloud for Sovereignty Landing Zone](architecture/CLOUD_FOR_SOVEREIGNTY_LANDING_ZONE.md)
|
||
|
|
2. [Well-Architected Framework](architecture/README.md)
|
||
|
|
|
||
|
|
### 🔐 Security Engineers
|
||
|
|
|
||
|
|
**Security**
|
||
|
|
1. [Security Policies](governance/SECURITY.md)
|
||
|
|
2. [Architecture Security](architecture/README.md#security)
|
||
|
|
3. [Compliance](governance/README.md#compliance)
|
||
|
|
|
||
|
|
**Compliance**
|
||
|
|
1. [Cloud for Sovereignty](architecture/CLOUD_FOR_SOVEREIGNTY_LANDING_ZONE.md)
|
||
|
|
2. [GDPR Compliance](governance/README.md)
|
||
|
|
3. [eIDAS Compliance](integrations/entra-verifiedid/README.md)
|
||
|
|
|
||
|
|
### 📋 Project Managers
|
||
|
|
|
||
|
|
**Project Status**
|
||
|
|
1. [Task Completion Status](reports/TASK_COMPLETION_STATUS.md)
|
||
|
|
2. [Comprehensive Review](reports/COMPREHENSIVE_PROJECT_REVIEW.md)
|
||
|
|
3. [Remaining Steps](reports/REMAINING_STEPS_COMPLETE.md)
|
||
|
|
|
||
|
|
**Architecture**
|
||
|
|
1. [Sovereignty Landing Zone Summary](architecture/SOVEREIGNTY_LANDING_ZONE_SUMMARY.md)
|
||
|
|
2. [Architecture Overview](architecture/README.md)
|
||
|
|
|
||
|
|
## 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
|
||
|
|
```bash
|
||
|
|
find docs -name README.md
|
||
|
|
```
|
||
|
|
|
||
|
|
**Guides** - How-to guides
|
||
|
|
```bash
|
||
|
|
find docs -name "*GUIDE*.md"
|
||
|
|
find docs -name "*SETUP*.md"
|
||
|
|
```
|
||
|
|
|
||
|
|
**Architecture** - Architecture documentation
|
||
|
|
```bash
|
||
|
|
find docs -name "*ARCHITECTURE*.md"
|
||
|
|
find docs -name "*LANDING*.md"
|
||
|
|
```
|
||
|
|
|
||
|
|
**Reports** - Status reports
|
||
|
|
```bash
|
||
|
|
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
|
||
|
|
|