Skip to content

📝 docs: complete Phase 0.6 Documentation updates #24

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
trickpatty merged 1 commit into from
Dec 23, 2025
Merged

📝 docs: complete Phase 0.6 Documentation updates #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions docs/ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Luminous Architecture Document

> **Document Version:** 2.2.0
> **Last Updated:** 2025-12-22
> **Status:** Draft
> **Document Version:** 2.3.0
> **Last Updated:** 2025-12-23
> **Status:** Active
> **TOGAF Phase:** Phase B-D (Architecture Development)

---
Expand Down Expand Up @@ -729,3 +729,4 @@ services:
| 2.0.0 | 2025-12-21 | Luminous Team | Updated for Azure/.NET/Angular stack, multi-tenancy |
| 2.1.0 | 2025-12-21 | Luminous Team | Migrate from Guid to NanoId for unique identifiers |
| 2.2.0 | 2025-12-22 | Luminous Team | Added CI/CD documentation reference |
| 2.3.0 | 2025-12-23 | Luminous Team | Phase 0 complete: Updated status to Active |
31 changes: 18 additions & 13 deletions docs/PROJECT-OVERVIEW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Luminous Project Overview

> **Document Version:** 2.0.0
> **Last Updated:** 2025-12-21
> **Status:** Draft
> **Document Version:** 2.1.0
> **Last Updated:** 2025-12-23
> **Status:** Active
> **TOGAF Phase:** Architecture Vision (Phase A)

---
Expand Down Expand Up @@ -109,14 +109,14 @@ Luminous is deployed as a cloud-hosted platform on Microsoft Azure, supporting m
| **Real-time Sync** | WebSocket-based synchronization | Azure SignalR Service |
| **Data Storage** | Document database per family | Azure Cosmos DB |
| **File Storage** | Media and file uploads | Azure Blob Storage |
| **Identity** | User authentication and authorization | Azure AD B2C |
| **Identity** | User authentication and authorization | In-House Passwordless (WebAuthn/Passkeys) |
| **Background Jobs** | Calendar sync, import processing | Azure Functions |

#### Multi-Tenancy Model

Each family represents a **tenant** with complete data isolation:

1. **Sign-Up Flow**: Users register via Azure AD B2C (email/password or social login)
1. **Sign-Up Flow**: Users register via passkey (WebAuthn), email OTP, or social login
2. **Family Creation**: First user creates a family (tenant) and becomes the Owner
3. **Member Invitation**: Owner invites family members via email or link
4. **Device Linking**: Wall displays are linked to families via 6-digit codes
Expand Down Expand Up @@ -175,7 +175,7 @@ Developers can run the full stack locally using:
| Blob Storage | Azurite |
| Redis Cache | Docker Redis |
| Azure Functions | Azure Functions Core Tools |
| Azure AD B2C | Dev B2C tenant or local JWT issuer |
| Identity Service | Local JWT issuer (DevAuth endpoint) |

See [Local Development Guide](./DEVELOPMENT.md) for setup instructions.

Expand Down Expand Up @@ -672,13 +672,16 @@ Detailed Architecture Decision Records (ADRs) are maintained in `/docs/adr/`. Ke

| ADR | Title | Status |
|-----|-------|--------|
| ADR-001 | Use TypeScript for all application code | Accepted |
| ADR-002 | React for display and mobile applications | Accepted |
| ADR-003 | Local-first data architecture with sync | Accepted |
| ADR-004 | Two-way sync initially limited to Google Calendar | Accepted |
| ADR-005 | Magic Import requires explicit approval | Accepted |
| ADR-006 | Zero-distraction principle (no entertainment) | Accepted |
| ADR-007 | Self-hosting as primary deployment model | Accepted |
| ADR-001 | .NET 10 as Backend Platform | Accepted |
| ADR-002 | Angular as Web Framework | Accepted |
| ADR-003 | Azure as Cloud Platform | Accepted |
| ADR-004 | Native iOS and Android Apps | Accepted |
| ADR-005 | CosmosDB as Primary Data Store | Accepted |
| ADR-006 | Multi-Tenant Architecture | Accepted |
| ADR-007 | Bicep with AVMs for Infrastructure as Code | Accepted |
| ADR-008 | Magic Import Requires Approval | Accepted |
| ADR-009 | Zero-Distraction Design Principle | Accepted |
| ADR-010 | In-House Passwordless Authentication | Accepted |

---

Expand Down Expand Up @@ -731,6 +734,8 @@ Detailed Architecture Decision Records (ADRs) are maintained in `/docs/adr/`. Ke
| Version | Date | Author | Changes |
|---------|------|--------|---------|
| 1.0.0 | 2025-12-21 | Luminous Team | Initial draft |
| 2.0.0 | 2025-12-21 | Luminous Team | Updated for Azure/.NET/Angular stack |
| 2.1.0 | 2025-12-23 | Luminous Team | Updated ADR references to match implemented architecture |

---

Expand Down
30 changes: 21 additions & 9 deletions docs/ROADMAP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Luminous Development Roadmap

> **Document Version:** 2.5.0
> **Last Updated:** 2025-12-22
> **Document Version:** 2.6.0
> **Last Updated:** 2025-12-23
> **Status:** Active
> **TOGAF Phase:** Phase E/F (Opportunities, Solutions & Migration Planning)

Expand Down Expand Up @@ -102,7 +102,7 @@ Phase 6: Intelligence & Ecosystem

| Phase | Name | Focus | Key Deliverables | Status |
|-------|------|-------|------------------|--------|
| **0** | Foundation | Infrastructure | Azure IaC, .NET solution, Angular shell, Passwordless Auth, Local Dev, CI/CD | 🟡 In Progress (0.1-0.5 Complete) |
| **0** | Foundation | Infrastructure | Azure IaC, .NET solution, Angular shell, Passwordless Auth, Local Dev, CI/CD, Docs | ✅ Complete |
| **1** | Core Platform | Multi-tenancy | Family sign-up, device linking, CosmosDB, web MVP | ⬜ Not Started |
| **2** | Display & Calendar | Calendar visibility | Display app, calendar integration, SignalR sync | ⬜ Not Started |
| **3** | Native Mobile | Mobile apps | iOS (Swift), Android (Kotlin), push notifications | ⬜ Not Started |
Expand Down Expand Up @@ -231,13 +231,24 @@ Establish the Azure infrastructure, .NET backend, Angular frontend, and developm
- [x] Artifact management for build outputs
- [x] Bundle size analysis for Angular builds

#### 0.6 Documentation
#### 0.6 Documentation ✅ COMPLETED

- [ ] **0.6.1** Complete PROJECT-OVERVIEW.md
- [ ] **0.6.2** Complete ARCHITECTURE.md
- [ ] **0.6.3** Complete ROADMAP.md
- [ ] **0.6.4** Create ADRs for technology decisions
- [ ] **0.6.5** Create local development setup guide
- [x] **0.6.1** Complete PROJECT-OVERVIEW.md
- *Implemented: Comprehensive product specification with deployment model, personas, UX principles, and functional scope*
- [x] **0.6.2** Complete ARCHITECTURE.md
- *Implemented: Full architecture document covering all TOGAF phases (business, data, application, technology)*
- [x] **0.6.3** Complete ROADMAP.md
- *Implemented: Detailed roadmap with phases 0-6, dependencies, and risk register*
- [x] **0.6.4** Create ADRs for technology decisions
- *Implemented: 10 ADRs covering .NET backend, Angular, Azure, native mobile, CosmosDB, multi-tenancy, Bicep/AVMs, Magic Import, zero-distraction, and passwordless auth*
- [x] **0.6.5** Create local development setup guide
- *Implemented: DEVELOPMENT.md with Docker Compose setup, VS Code configuration, troubleshooting, and ARM64 support*

**Additional deliverables:**
- [x] AZURE-INFRASTRUCTURE.md with detailed resource documentation
- [x] CI-CD.md with GitHub Actions pipeline documentation
- [x] ADR template (ADR-000-template.md) for future decisions
- [x] CLAUDE.md with comprehensive development guidelines

### Exit Criteria

Expand Down Expand Up @@ -683,3 +694,4 @@ These can be developed in parallel after Phase 0:
| 2.3.0 | 2025-12-21 | Luminous Team | Phase 0.3 Angular Web Application completed |
| 2.4.0 | 2025-12-22 | Luminous Team | Phase 0.4 Local Development Environment completed |
| 2.5.0 | 2025-12-22 | Luminous Team | Phase 0.5 CI/CD Pipeline completed |
| 2.6.0 | 2025-12-23 | Luminous Team | Phase 0.6 Documentation completed; Phase 0 complete |