Skip to content

docs: label cardinality on the README diagram - #61

Merged
liam-machine merged 1 commit into
mainfrom
docs/diagram-cardinality
Sep 12, 2026
Merged

liam-machine merged 1 commit into
mainfrom
docs/diagram-cardinality

Conversation

@liam-machine

Copy link
Copy Markdown
Owner

Summary

The "Simple by design" diagram joined dim_customer and fct_order with an unlabelled line, so it showed that the two models were related without showing how. The relationship is now labelled 1 at the dimension and * at the fact.

The notation matches what ERD Studio actually renders on the canvas: FkEdge.tsx uses Power BI-style labels, a 14px 1 and a deliberately larger 22px *, rather than crow's feet. The diagram now reflects the product instead of inventing its own convention.

Source is docs/assets/readme-workflow.svg, re-exported to media/readme-workflow.png at 2240x792 with rsvg-convert. The PNG is excluded from the .vsix, so the published extension bytes are unchanged.

Test plan

  • Rendered PNG inspected — 1 sits at the dim_customer end, * at the fct_order end, neither overlapping a node border
  • PNG dimensions unchanged at 2240x792 (2x the SVG viewBox)
  • vsce ls still lists 12 files; the diagram is not among them
  • After merge: deploy publishes v1.0.1 and creates the v1.0.1 tag and GitHub Release

🤖 Generated with Claude Code

https://claude.ai/code/session_014ywafwDpxdWWBt26Q1keiP

The line joining dim_customer and fct_order carried no notation, so the
picture showed that the two models were related without showing how. It
now reads 1 at the dimension and * at the fact, matching the Power BI
style labels the canvas itself renders, so the diagram says one customer
to many orders rather than leaving it to be inferred from the key names.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014ywafwDpxdWWBt26Q1keiP
@liam-machine
liam-machine merged commit 5dc6583 into main Sep 12, 2026
3 checks passed
@liam-machine
liam-machine deleted the docs/diagram-cardinality branch September 12, 2026 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant