Skip to content

Conversation

anettkva
Copy link
Member

@anettkva anettkva commented Oct 2, 2026

Summary

Adds docs/DATA_MODEL.md, which describes the data model for the Code of Points catalog and the user data, and docs/AI_USAGE.md, which documents how AI was used to create it.

Changes

  • ER diagram (Mermaid) of all entities and how they relate
  • Description of each entity and its fields
  • Constraints for catalog data, user data and calculated values
  • Reasoning behind the main design decisions, e.g. vault as its own entity, variant groups, and calculating the D-score instead of storing it
  • AI usage documentation in docs/AI_USAGE.md

Closes #7

Anettkva added 4 commits October 1, 2026 15:31
Replaces docs/mermaidDiagram.md with docs/DATA_MODEL.md, which
includes the diagram and describes the entities, relations,
constraints and design choices.
@anettkva anettkva requested a review from a team as a code owner October 2, 2026 08:01
@anettkva anettkva linked an issue Oct 2, 2026 that may be closed by this pull request
Copy link
Member

@ronjalh ronjalh left a comment •

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@ronjalh ronjalh merged commit 9028d81 into main Oct 2, 2026
@ronjalh ronjalh deleted the 7-potential-database-er-diagram-readme branch October 2, 2026 08:20
Sign in to join this conversation on GitHub.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

potential database ER diagram readme
2 participants