@@ -31,42 +31,42 @@ Applied satellite of the [Evolith](https://github.com/beyondnetcode/evolith_arch
3131
3232---
3333
34- ## 📑 Quick Navigation Menu
34+ ## Quick Navigation Menu
3535
3636| Category | Entry Point | Description |
3737| ---| ---| ---|
38- | 📐 ** Architecture** | [ Architecture Portal] ( ./docs/architecture/index.md ) | Blueprints, ADRs, TEs, canonical patterns |
39- | 🏛️ ** ADRs** | [ ADR Registry] ( ./docs/architecture/adrs/ ) | 32 architecture decisions |
40- | 🧩 ** Domain Model** | [ Aggregate Index] ( ./docs/domain/index.md ) | Bounded contexts · aggregates · entities |
41- | 📦 ** SDK** | [ SDK Portal] ( ./docs/sdk/index.md ) | .NET · TypeScript · NestJS |
42- | 📋 ** Requirements** | [ Functional Stories] ( ./docs/governance/requirements/functional-stories/index.md ) | Full product backlog |
43- | 🚦 ** Planning** | [ Project Backlog] ( ./docs/governance/project/index.md ) | Epics · MVP · gap tracker |
44- | ⚙️ ** Operations** | [ Operations Portal] ( ./docs/operations/index.md ) | Runbooks · metrics |
45- | 🧪 ** QA** | [ QA Report] ( ./docs/qa/qa_report.md ) | Test results · coverage · evidences |
46- | 🏗️ ** Infrastructure** | [ K8s Plan] ( ./infra/UMS_K8s_Deployment_Plan.md ) | Kubernetes deployment guide |
47- | 📖 ** Full Index** | [ Master Index] ( ./docs/MASTER_INDEX.md ) | Complete lifecycle navigation |
48- | 🔺 ** Evolith Upstream** | [ Evolith Framework] ( https://github.com/beyondnetcode/evolith_arch32 ) | Architecture reference base |
38+ | ** Architecture** | [ Architecture Portal] ( ./docs/architecture/index.md ) | Blueprints, ADRs, TEs, canonical patterns |
39+ | ** ADRs** | [ ADR Registry] ( ./docs/architecture/adrs/ ) | 32 architecture decisions |
40+ | ** Domain Model** | [ Aggregate Index] ( ./docs/domain/index.md ) | Bounded contexts · aggregates · entities |
41+ | ** SDK** | [ SDK Portal] ( ./docs/sdk/index.md ) | .NET · TypeScript · NestJS |
42+ | ** Requirements** | [ Functional Stories] ( ./docs/governance/requirements/functional-stories/index.md ) | Full product backlog |
43+ | ** Planning** | [ Project Backlog] ( ./docs/governance/project/index.md ) | Epics · MVP · gap tracker |
44+ | ** Operations** | [ Operations Portal] ( ./docs/operations/index.md ) | Runbooks · metrics |
45+ | ** QA** | [ QA Report] ( ./docs/qa/qa_report.md ) | Test results · coverage · evidences |
46+ | ** Infrastructure** | [ K8s Plan] ( ./infra/UMS_K8s_Deployment_Plan.md ) | Kubernetes deployment guide |
47+ | ** Full Index** | [ Master Index] ( ./docs/MASTER_INDEX.md ) | Complete lifecycle navigation |
48+ | ** Evolith Upstream** | [ Evolith Framework] ( https://github.com/beyondnetcode/evolith_arch32 ) | Architecture reference base |
4949
5050---
5151
52- ## 🎯 Start Here — Choose Your Path
52+ ## Start Here — Choose Your Path
5353
5454### Path 1 — 5-Minute Overview
5555
56- 📄 [ Product Vision] ( ./docs/governance/product/product-vision.md ) · [ Architecture Overview] ( ./docs/architecture/overview.md ) · [ Traceability Matrix] ( ./docs/architecture/traceability-matrix.md )
56+ [ Product Vision] ( ./docs/governance/product/product-vision.md ) · [ Architecture Overview] ( ./docs/architecture/overview.md ) · [ Traceability Matrix] ( ./docs/architecture/traceability-matrix.md )
5757
5858* What is UMS? What problem does it solve? How does it fit Evolith?*
5959
6060### Path 2 — By Role
6161
6262| Role | Start Here | Then Read |
6363| ---| ---| ---|
64- | 🏛️ ** Architect** | [ Architecture Portal] ( ./docs/architecture/index.md ) | [ ADR Registry] ( ./docs/architecture/adrs/ ) · [ Traceability Matrix] ( ./docs/architecture/traceability-matrix.md ) |
65- | 👨💻 ** Backend Dev** | [ Canonical Patterns] ( ./docs/architecture/artifacts/canonical-patterns/index.md ) | [ Domain Aggregates] ( ./docs/domain/index.md ) · [ .NET SDK] ( ./docs/sdk/dotnet/README.md ) |
66- | 🖥️ ** Frontend Dev** | [ ADR-0056: Clean Architecture] ( ./docs/architecture/adrs/0056-clean-architecture-frontend.md ) | [ TypeScript SDK] ( ./docs/sdk/typescript/README.md ) · [ ADR-0057: State Mgmt] ( ./docs/architecture/adrs/0057-zustand-tanstack-query-state.md ) |
67- | 🛠️ ** DevOps / SRE** | [ Infrastructure Plan] ( ./infra/infrastructure_plan.md ) | [ Runbooks] ( ./docs/operations/runbooks/ ) · [ Metrics] ( ./docs/operations/metrics/index.md ) |
68- | 📦 ** Product / PM** | [ Product Vision] ( ./docs/governance/product/product-vision.md ) | [ Gap Tracker] ( ./docs/governance/project/functional-story-gap-tracker.md ) · [ OKRs] ( ./docs/governance/product/objectives.md ) |
69- | 🤖 ** AI Contributor** | [ AGENTS.md] ( ./AGENTS.md ) | [ ADR Template] ( ./docs/governance/sdlc/adr-template.md ) |
64+ | ** Architect** | [ Architecture Portal] ( ./docs/architecture/index.md ) | [ ADR Registry] ( ./docs/architecture/adrs/ ) · [ Traceability Matrix] ( ./docs/architecture/traceability-matrix.md ) |
65+ | ** Backend Dev** | [ Canonical Patterns] ( ./docs/architecture/artifacts/canonical-patterns/index.md ) | [ Domain Aggregates] ( ./docs/domain/index.md ) · [ .NET SDK] ( ./docs/sdk/dotnet/README.md ) |
66+ | ** Frontend Dev** | [ ADR-0056: Clean Architecture] ( ./docs/architecture/adrs/0056-clean-architecture-frontend.md ) | [ TypeScript SDK] ( ./docs/sdk/typescript/README.md ) · [ ADR-0057: State Mgmt] ( ./docs/architecture/adrs/0057-zustand-tanstack-query-state.md ) |
67+ | ** DevOps / SRE** | [ Infrastructure Plan] ( ./infra/infrastructure_plan.md ) | [ Runbooks] ( ./docs/operations/runbooks/ ) · [ Metrics] ( ./docs/operations/metrics/index.md ) |
68+ | ** Product / PM** | [ Product Vision] ( ./docs/governance/product/product-vision.md ) | [ Gap Tracker] ( ./docs/governance/project/functional-story-gap-tracker.md ) · [ OKRs] ( ./docs/governance/product/objectives.md ) |
69+ | ** AI Contributor** | [ AGENTS.md] ( ./AGENTS.md ) | [ ADR Template] ( ./docs/governance/sdlc/adr-template.md ) |
7070
7171### Path 3 — Make an Architectural Decision
7272
@@ -76,9 +76,9 @@ Applied satellite of the [Evolith](https://github.com/beyondnetcode/evolith_arch
7676
7777---
7878
79- ## 📂 Repository Structure (Deep Dive)
79+ ## Repository Structure (Deep Dive)
8080
81- ### 📐 Architecture & Patterns
81+ ### Architecture & Patterns
8282
8383| Artifact | Purpose |
8484| ---| ---|
@@ -90,7 +90,7 @@ Applied satellite of the [Evolith](https://github.com/beyondnetcode/evolith_arch
9090| [ Canonical Patterns] ( ./docs/architecture/artifacts/canonical-patterns/index.md ) | CP-01 through CP-08 |
9191| [ API Reference (.NET)] ( ./docs/architecture/api-dotnet/ ) | HTTP contract reference |
9292
93- ### 🏛️ Architecture Decision Records
93+ ### Architecture Decision Records
9494
9595| ADR | Title | Evolith |
9696| ---| ---| ---|
@@ -127,7 +127,7 @@ Applied satellite of the [Evolith](https://github.com/beyondnetcode/evolith_arch
127127| [ 0080] ( ./docs/architecture/adrs/0080-auth-graph-preview-internal-pipeline.md ) | Auth Graph Preview Pipeline | UMS-specific |
128128| [ 0081] ( ./docs/architecture/adrs/0081-semantic-auth-graph-client-contract.md ) | Semantic Auth Graph Contract | UMS-specific |
129129
130- ### 🧩 Domain Model
130+ ### Domain Model
131131
132132| Bounded Context | Aggregates |
133133| ---| ---|
@@ -140,7 +140,7 @@ Applied satellite of the [Evolith](https://github.com/beyondnetcode/evolith_arch
140140
141141Also: [ Bounded Context Map] ( ./docs/governance/construction/ddd-design/01-bounded-context-map.md ) · [ Cross-Context Flows] ( ./docs/governance/construction/ddd-design/10-cross-context-flows.md ) · [ DDD Primitives] ( ./docs/governance/construction/ddd-design/11-ddd-primitives.md )
142142
143- ### 📦 SDK
143+ ### SDK
144144
145145| Runtime | README | Quickstart |
146146| ---| ---| ---|
@@ -150,7 +150,7 @@ Also: [Bounded Context Map](./docs/governance/construction/ddd-design/01-bounded
150150
151151Contracts: [ Schema Overview] ( ./docs/sdk/contracts/schema-overview.md ) · [ Error Codes] ( ./docs/sdk/contracts/error-codes.md ) · [ Compatibility Matrix] ( ./docs/sdk/contracts/compatibility-matrix.md ) · [ Semantic Client Contract] ( ./docs/sdk/contracts/semantic-client-contract.md )
152152
153- ### 📋 Product & Requirements
153+ ### Product & Requirements
154154
155155| Artifact | Purpose |
156156| ---| ---|
@@ -164,7 +164,7 @@ Contracts: [Schema Overview](./docs/sdk/contracts/schema-overview.md) · [Error
164164| [ Conceptual Data Model] ( ./docs/governance/requirements/conceptual-data-model.md ) | High-level domain model |
165165| [ Permission Matrix] ( ./docs/governance/requirements/permission-matrix-example.md ) | Role/permission reference |
166166
167- ### 🚦 Planning & Backlog
167+ ### Planning & Backlog
168168
169169| Artifact | Purpose |
170170| ---| ---|
@@ -175,7 +175,7 @@ Contracts: [Schema Overview](./docs/sdk/contracts/schema-overview.md) · [Error
175175| [ Epic 07: Compliance] ( ./docs/governance/project/ep-07-compliance-detailed-design.md ) | Compliance module design |
176176| [ Epic 08: IGA] ( ./docs/governance/project/ep-08-iga-detailed-design.md ) | Identity Governance design |
177177
178- ### ⚙️ Operations
178+ ### Operations
179179
180180| Artifact | Purpose |
181181| ---| ---|
@@ -187,7 +187,7 @@ Contracts: [Schema Overview](./docs/sdk/contracts/schema-overview.md) · [Error
187187| [ Dev DB Anonymization] ( ./docs/operations/runbooks/dev-db-anonymization.md ) | PII anonymization for dev environments |
188188| [ GDPR Backup Retention] ( ./docs/operations/runbooks/gdpr-backup-retention-policy.md ) | Backup retention compliance |
189189
190- ### 🧪 QA & Testing
190+ ### QA & Testing
191191
192192| Artifact | Purpose |
193193| ---| ---|
@@ -198,7 +198,7 @@ Contracts: [Schema Overview](./docs/sdk/contracts/schema-overview.md) · [Error
198198| [ Performance Testing Results] ( ./docs/governance/testing/performance-testing-results.md ) | Load test outcomes |
199199| [ QA Evidences] ( ./docs/qa/evidences/ ) | US-001 through US-008 screenshots |
200200
201- ### 🏗️ Infrastructure
201+ ### Infrastructure
202202
203203| Artifact | Purpose |
204204| ---| ---|
@@ -209,7 +209,7 @@ Contracts: [Schema Overview](./docs/sdk/contracts/schema-overview.md) · [Error
209209
210210---
211211
212- ## 🔧 Local Development
212+ ## Local Development
213213
214214``` bash
215215# Install all dependencies
@@ -232,7 +232,7 @@ python .bmad-core/scripts/validate_docs_consistency.py README.md docs/
232232
233233---
234234
235- ## 🔺 UMS vs Evolith — What Goes Where
235+ ## UMS vs Evolith — What Goes Where
236236
237237| Question | Evolith (Upstream) | UMS (Satellite Product) |
238238| ---| ---| ---|
@@ -244,7 +244,7 @@ python .bmad-core/scripts/validate_docs_consistency.py README.md docs/
244244
245245---
246246
247- ## 🤝 Contributing
247+ ## Contributing
248248
249249Before contributing, read:
250250
@@ -255,7 +255,7 @@ Before contributing, read:
255255
256256---
257257
258- ## 📋 All Navigation Indexes
258+ ## All Navigation Indexes
259259
260260| Index | Purpose |
261261| ---| ---|
0 commit comments