personal-projects/personal-portfolio
Template
1
1
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects 1 Releases Wiki Activity

Add Architecture section to README.md #78

New Issue
Closed
opened 2026-01-17 21:53:42 +00:00 by lmiranda · 0 comments
lmiranda commented 2026-01-17 21:53:42 +00:00
Owner
Copy Link

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.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Complexity/Complex
High uncertainty or many dependencies
 Complexity/Medium
Some unknowns or dependencies
 Complexity/Simple
Straightforward, well-understood
 Effort/L
3-5 days
 Effort/M
1-2 days
 Effort/S
2-4 hours
 Effort/XL
> 1 week
 Effort/XS
< 2 hours
 Priority/Critical
Immediate attention required
 Priority/High
Important, needs attention soon
 Priority/Low
Nice to have, can wait
 Priority/Medium
Normal priority
 Type/Bug
Something isn't working
 Type/Chore
Maintenance tasks
 Type/Documentation
Documentation improvements
 Type/Feature
New feature or request
 Type/Refactor
Code refactoring without changing behavior
 Type/Test
Testing related
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
lmiranda
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: personal-projects/personal-portfolio#78
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?