Appearance
Heritage Community Hub — Architecture Documentation
Internal documentation hub for the Heritage Virginia community platform (Nickelsville, VA).
What's here
| Section | Content |
|---|---|
| Architecture | System overview, provider abstraction, notification transport, live topology |
| Generated | Auto-generated ERD (40 models), module dependency graph, TypeDoc API reference |
| ADRs | Architecture decision records (0001–0046) |
| Design | API contracts, data model, auth/RBAC, security, push notifications |
| Build | Local dev, CI/CD, workspace setup |
| Overview | Executive summary, ministry overview, action plan, repo strategy |
Auto-generated artifacts
The content under Generated is rebuilt automatically on every push to main via the build-arch-docs CI job. Never edit those files by hand — they will be overwritten.
- ERD — Prisma schema rendered as a Mermaid entity-relationship diagram (40 models)
- Dependency graph — Import graph across all apps and packages (dependency-cruiser)
- API reference — TypeDoc output for all shared packages
- Prisma table docs — Per-model column/relation reference (prisma-docs-generator)
Live runtime topology
The one map that reflects what's running right now is the Azure Application Insights Application Map — see Live Topology for the link and how to read it.