Skip to content

Enhance documentation clarity and structure #233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Evilazaro merged 9 commits into from
Jan 23, 2026
Merged

Enhance documentation clarity and structure #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f3e00b1
Enhance version calculation flowchart in release documentation for im…
Evilazaro Jan 23, 2026
b451cf8
Update deployment architecture documentation for clarity and complete…
Evilazaro Jan 23, 2026
759c7fd
Enhance high-level architecture diagrams in deployment documentation …
Evilazaro Jan 23, 2026
262dc16
Enhance detailed CI/CD flow diagram in deployment architecture docume…
Evilazaro Jan 23, 2026
8207cde
Enhance flowchart styles in architecture documentation for improved v…
Evilazaro Jan 23, 2026
8a7a4dc
Enhance table of contents links across architecture and script docume…
Evilazaro Jan 23, 2026
44f472e
Add initial README.md with project overview, features, architecture, …
Evilazaro Jan 23, 2026
5c1f272
docs: enhance README with improved structure, feature table, and upda…
Evilazaro Jan 23, 2026
6c89c27
docs: enhance architecture documentation with detailed landing zone o…
Evilazaro Jan 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
805 changes: 805 additions & 0 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

19 changes: 10 additions & 9 deletions docs/architecture/01-business-architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,15 @@ tags:

## 📑 Table of Contents

- [📋 Executive Summary](#executive-summary)
- [🎯 Business Context](#business-context)
- [👥 Stakeholder Analysis](#stakeholder-analysis)
- [⚙️ Business Capabilities](#business-capabilities)
- [🔄 Value Streams](#value-streams)
- [📝 Business Requirements](#business-requirements)
- [📊 Success Metrics](#success-metrics)
- [📖 Glossary](#glossary)
- [🔗 References](#references)
- [📋 Executive Summary](#-executive-summary)
- [🎯 Business Context](#-business-context)
- [👥 Stakeholder Analysis](#-stakeholder-analysis)
- [⚙️ Business Capabilities](#%EF%B8%8F-business-capabilities)
- [🔄 Value Streams](#-value-streams)
- [📝 Business Requirements](#-business-requirements)
- [📊 Success Metrics](#-success-metrics)
- [📖 Glossary](#-glossary)
- [🔗 References](#-references)

---

Expand Down Expand Up @@ -278,6 +278,7 @@ flowchart TB
class C9,C10,C11,C12 secondary
class C13,C14,C15 primary

style L1 fill:#F3F4F6,stroke:#6B7280,stroke-width:2px
style L2A fill:#FEF3C7,stroke:#F59E0B,stroke-width:2px
style L2B fill:#FEE2E2,stroke:#F44336,stroke-width:2px
style L2C fill:#ECFDF5,stroke:#10B981,stroke-width:2px
Expand Down
19 changes: 10 additions & 9 deletions docs/architecture/02-data-architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,15 @@ tags:

## 📑 Table of Contents

- [📊 Data Overview](#data-overview)
- [📁 Configuration Data Model](#configuration-data-model)
- [🔐 Secrets Management](#secrets-management)
- [📶 Telemetry & Diagnostics](#telemetry--diagnostics)
- [🔄 Data Flow Diagrams](#data-flow-diagrams)
- [🛡️ Data Governance](#data-governance)
- [📝 Schema Documentation](#schema-documentation)
- [📖 Glossary](#glossary)
- [🔗 References](#references)
- [📊 Data Overview](#-data-overview)
- [📁 Configuration Data Model](#-configuration-data-model)
- [🔐 Secrets Management](#-secrets-management)
- [📶 Telemetry & Diagnostics](#-telemetry--diagnostics)
- [🔄 Data Flow Diagrams](#-data-flow-diagrams)
- [🛡️ Data Governance](#%EF%B8%8F-data-governance)
- [📝 Schema Documentation](#-schema-documentation)
- [📖 Glossary](#-glossary)
- [🔗 References](#-references)

---

Expand Down Expand Up @@ -105,6 +105,7 @@ flowchart TB
class T1,T2,T3 secondary
class ST1,ST2,ST3 datastore

style DataCategories fill:#F3F4F6,stroke:#6B7280,stroke-width:2px
style Config fill:#E0E7FF,stroke:#4F46E5,stroke-width:2px
style Secrets fill:#FEE2E2,stroke:#F44336,stroke-width:2px
style Telemetry fill:#ECFDF5,stroke:#10B981,stroke-width:2px
Expand Down
18 changes: 9 additions & 9 deletions docs/architecture/03-application-architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,15 @@ tags:

## 📑 Table of Contents

- [📊 Application Overview](#application-overview)
- [📋 Bicep Module Catalog](#bicep-module-catalog)
- [🔗 Module Dependency Graph](#module-dependency-graph)
- [📜 Interface Contracts](#interface-contracts)
- [🚀 Deployment Orchestration](#deployment-orchestration)
- [🔧 Component Details](#component-details)
- [🔄 Integration Patterns](#integration-patterns)
- [🔌 Extension Points](#extension-points)
- [📚 References](#references)
- [📊 Application Overview](#-application-overview)
- [📋 Bicep Module Catalog](#-bicep-module-catalog)
- [🔗 Module Dependency Graph](#-module-dependency-graph)
- [📜 Interface Contracts](#-interface-contracts)
- [🚀 Deployment Orchestration](#-deployment-orchestration)
- [🔧 Component Details](#-component-details)
- [🔄 Integration Patterns](#-integration-patterns)
- [🔌 Extension Points](#-extension-points)
- [📚 References](#-references)

---

Expand Down
31 changes: 21 additions & 10 deletions docs/architecture/04-technology-architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,16 @@ tags:

## 📑 Table of Contents

- [📊 Technology Overview](#technology-overview)
- [📦 Azure Service Catalog](#azure-service-catalog)
- [🏗️ Landing Zone Design](#landing-zone-design)
- [🌐 Network Architecture](#network-architecture)
- [💻 Compute Architecture](#compute-architecture)
- [🔄 CI/CD Infrastructure](#cicd-infrastructure)
- [📶 Monitoring Infrastructure](#monitoring-infrastructure)
- [📏 Infrastructure Sizing](#infrastructure-sizing)
- [📜 Technology Standards](#technology-standards)
- [🔗 References](#references)
- [📊 Technology Overview](#-technology-overview)
- [📦 Azure Service Catalog](#-azure-service-catalog)
- [🏗️ Landing Zone Design](#%EF%B8%8F-landing-zone-design)
- [🌐 Network Architecture](#-network-architecture)
- [💻 Compute Architecture](#-compute-architecture)
- [🔄 CI/CD Infrastructure](#-cicd-infrastructure)
- [📶 Monitoring Infrastructure](#-monitoring-infrastructure)
- [📏 Infrastructure Sizing](#-infrastructure-sizing)
- [📜 Technology Standards](#-technology-standards)
- [🔗 References](#-references)

---

Expand Down Expand Up @@ -128,6 +128,10 @@ flowchart TB
style IaC fill:#FEF3C7,stroke:#F59E0B,stroke-width:2px
style CI_CD fill:#EEF2FF,stroke:#4F46E5,stroke-width:2px
style Azure fill:#ECFDF5,stroke:#10B981,stroke-width:2px
style Compute fill:#D1FAE5,stroke:#059669,stroke-width:1px
style Security fill:#D1FAE5,stroke:#059669,stroke-width:1px
style Network fill:#D1FAE5,stroke:#059669,stroke-width:1px
style Monitor fill:#D1FAE5,stroke:#059669,stroke-width:1px
```

### Technology Decision Matrix
Expand Down Expand Up @@ -517,6 +521,9 @@ flowchart TB

style DevCenter fill:#E0E7FF,stroke:#4F46E5,stroke-width:2px
style Runtime fill:#ECFDF5,stroke:#10B981,stroke-width:2px
style Images fill:#D1FAE5,stroke:#059669,stroke-width:1px
style Projects fill:#D1FAE5,stroke:#059669,stroke-width:1px
style Pools fill:#D1FAE5,stroke:#059669,stroke-width:1px
```

### Dev Box SKU Options
Expand Down Expand Up @@ -639,6 +646,8 @@ flowchart TB

style GitHub fill:#EEF2FF,stroke:#4F46E5,stroke-width:2px
style Azure fill:#ECFDF5,stroke:#10B981,stroke-width:2px
style Actions fill:#E0E7FF,stroke:#4F46E5,stroke-width:1px
style Secrets fill:#E0E7FF,stroke:#4F46E5,stroke-width:1px
```

### Workflow Pipeline Structure
Expand Down Expand Up @@ -791,6 +800,8 @@ flowchart TB
style Collection fill:#EEF2FF,stroke:#4F46E5,stroke-width:2px
style LAW fill:#E0E7FF,stroke:#4F46E5,stroke-width:2px
style Consumers fill:#ECFDF5,stroke:#10B981,stroke-width:2px
style Tables fill:#D1FAE5,stroke:#059669,stroke-width:1px
style Solutions fill:#D1FAE5,stroke:#059669,stroke-width:1px
```

### Diagnostic Settings Configuration
Expand Down
27 changes: 16 additions & 11 deletions docs/architecture/05-security-architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,17 @@ tags:

## 📑 Table of Contents

- [📊 Security Overview](#security-overview)
- [⚠️ Threat Model](#threat-model)
- [🔑 Identity & Access Management](#identity--access-management)
- [👥 RBAC Hierarchy](#rbac-hierarchy)
- [🔐 Secrets Management](#secrets-management)
- [🌐 Network Security](#network-security)
- [🛡️ Data Protection](#data-protection)
- [✅ Compliance & Governance](#compliance--governance)
- [📶 Security Operations](#security-operations)
- [📋 Security Controls Matrix](#security-controls-matrix)
- [🔗 References](#references)
- [📊 Security Overview](#-security-overview)
- [⚠️ Threat Model](#%EF%B8%8F-threat-model)
- [🔑 Identity & Access Management](#-identity--access-management)
- [👥 RBAC Hierarchy](#-rbac-hierarchy)
- [🔐 Secrets Management](#-secrets-management)
- [🌐 Network Security](#-network-security)
- [🛡️ Data Protection](#%EF%B8%8F-data-protection)
- [✅ Compliance & Governance](#-compliance--governance)
- [📶 Security Operations](#-security-operations)
- [📋 Security Controls Matrix](#-security-controls-matrix)
- [🔗 References](#-references)

---

Expand Down Expand Up @@ -542,6 +542,8 @@ flowchart TB
style Sources fill:#FEF3C7,stroke:#F59E0B,stroke-width:2px
style KeyVault fill:#FEE2E2,stroke:#F44336,stroke-width:2px
style Access fill:#ECFDF5,stroke:#10B981,stroke-width:2px
style Settings fill:#FECACA,stroke:#C62828,stroke-width:1px
style Secrets fill:#FECACA,stroke:#C62828,stroke-width:1px
```

### Key Vault Configuration
Expand Down Expand Up @@ -661,6 +663,9 @@ flowchart TB
style Internet fill:#F3F4F6,stroke:#6B7280,stroke-width:2px
style AzureNetwork fill:#E0E7FF,stroke:#4F46E5,stroke-width:2px
style Resources fill:#ECFDF5,stroke:#10B981,stroke-width:2px
style NSG fill:#D1FAE5,stroke:#059669,stroke-width:1px
style VNet fill:#D1FAE5,stroke:#059669,stroke-width:1px
style PE fill:#D1FAE5,stroke:#059669,stroke-width:1px
```

### Network Configuration Options
Expand Down
Loading
Loading