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

Create docs/DATABASE_SCHEMA.md #79

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

Overview

Create comprehensive database schema documentation with Mermaid ERD diagrams showing all tables, relationships, and schema organization.

Acceptance Criteria

  • Create docs/DATABASE_SCHEMA.md
  • Include Mermaid ERD diagram with all tables from toronto/models/
  • Show primary keys (PK) and foreign keys (FK) for each table
  • Document relationships between tables
  • Organize by schema layers:
    • Raw schema (source data)
    • Staging schema (cleaned/typed)
    • Marts schema (analytical tables)
  • Add table descriptions and column documentation
  • Link from README.md Architecture section

Technical Notes

Tables to document (from toronto/models/):

  • dim_neighbourhood
  • dim_cmhc_zone
  • dim_time
  • dim_policy_event
  • fact_rentals
  • Any staging/intermediate tables

Labels

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

Phase: 1 - Architecture Documentation

## Overview Create comprehensive database schema documentation with Mermaid ERD diagrams showing all tables, relationships, and schema organization. ## Acceptance Criteria - [ ] Create `docs/DATABASE_SCHEMA.md` - [ ] Include Mermaid ERD diagram with all tables from `toronto/models/` - [ ] Show primary keys (PK) and foreign keys (FK) for each table - [ ] Document relationships between tables - [ ] Organize by schema layers: - Raw schema (source data) - Staging schema (cleaned/typed) - Marts schema (analytical tables) - [ ] Add table descriptions and column documentation - [ ] Link from README.md Architecture section ## Technical Notes Tables to document (from toronto/models/): - dim_neighbourhood - dim_cmhc_zone - dim_time - dim_policy_event - fact_rentals - Any staging/intermediate tables ## Labels - Type/Documentation - Priority/Medium - Complexity/Medium - Component/Docs - Component/Database ## 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#79
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?