Area: docs · Effort: S
What: Generate and maintain an Entity Relationship Diagram (ERD) from the TypeORM entity definitions and include it in the project documentation.
Why: New contributors and reviewers need to understand the data model before they can make meaningful changes. An up-to-date ERD dramatically shortens the learning curve.
Acceptance Criteria:
- ERD is auto-generated as part of the CI pipeline
- Generated ERD is committed to
docs/schema/erd.png and updated on schema changes
- Tables, columns, types, and foreign key relationships are all visible
- A written description of the key entities and their relationships accompanies the ERD
Hints:
- Use
typeorm-uml or mermaid-js for ERD generation from TypeORM metadata
- Add ERD generation to the
migration:generate npm script
- Consider
prisma-erd-generator if migrating to Prisma in the future
Area: docs · Effort: S
What: Generate and maintain an Entity Relationship Diagram (ERD) from the TypeORM entity definitions and include it in the project documentation.
Why: New contributors and reviewers need to understand the data model before they can make meaningful changes. An up-to-date ERD dramatically shortens the learning curve.
Acceptance Criteria:
docs/schema/erd.pngand updated on schema changesHints:
typeorm-umlormermaid-jsfor ERD generation from TypeORM metadatamigration:generatenpm scriptprisma-erd-generatorif migrating to Prisma in the future