Add Architecture section to README.md #78

Closed
opened 2026-01-17 21:53:42 +00:00 by lmiranda · 0 comments
Owner

Overview

Add a comprehensive Architecture section to the main README.md with a Mermaid flowchart showing the data pipeline from sources through to the application layer.

Acceptance Criteria

  • Add ## Architecture section to README.md after the project introduction
  • Include Mermaid flowchart diagram showing:
    • Sources: City of Toronto API, Toronto Police API, CMHC Data
    • ETL Layer: Parsers, Loaders
    • Database: PostgreSQL/PostGIS, dbt Models (raw/staging/marts)
    • Application: Dash App, Plotly Figures
  • Flowchart renders correctly on Gitea
  • Link to detailed DATABASE_SCHEMA.md (created in Issue #2)

Labels

  • Type/Documentation
  • Priority/Medium
  • Complexity/Simple
  • Component/Docs

Phase: 1 - Architecture Documentation

## Overview Add a comprehensive Architecture section to the main README.md with a Mermaid flowchart showing the data pipeline from sources through to the application layer. ## Acceptance Criteria - [ ] Add `## Architecture` section to README.md after the project introduction - [ ] Include Mermaid flowchart diagram showing: - **Sources**: City of Toronto API, Toronto Police API, CMHC Data - **ETL Layer**: Parsers, Loaders - **Database**: PostgreSQL/PostGIS, dbt Models (raw/staging/marts) - **Application**: Dash App, Plotly Figures - [ ] Flowchart renders correctly on Gitea - [ ] Link to detailed DATABASE_SCHEMA.md (created in Issue #2) ## Labels - Type/Documentation - Priority/Medium - Complexity/Simple - Component/Docs ## Phase: 1 - Architecture Documentation
Sign in to join this conversation.