Skip to content

docs: add white background to README diagrams for dark mode - #81

Open
karakoc49 wants to merge 1 commit into
simatic-ax:mainfrom
karakoc49:docs/dark-mode-diagrams
Open

karakoc49 wants to merge 1 commit into
simatic-ax:mainfrom
karakoc49:docs/dark-mode-diagrams

Conversation

@karakoc49

Copy link
Copy Markdown

Fixes #56

The class diagrams in the README (state.png, transition.png, guard.png, logger.png) have black lines on a transparent background, so they are barely readable in GitHub's dark theme. This PR flattens them onto a white background with a small 10px margin. The diagram contents are unchanged. statecontroller.png already had an opaque background and is left as is.

Checked in GitHub's dark theme on my fork: the lines and arrows are now clearly visible.

If you would prefer theme-aware diagrams, I could convert them to Mermaid (like docs/classdiagram.md) in a follow-up.

The class diagram PNGs had black lines on a transparent background,
which made them barely readable in GitHub's dark theme. Flatten them
onto a white background with a small margin.

Fixes simatic-ax#56
@karakoc49
karakoc49 requested a review from a team as a code owner September 30, 2026 16:56
Copilot AI balanced review requested due to automatic review settings September 30, 2026 16:56

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request. Check if the Files changed in this pull request are included in default exclusions.

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.

Readme.md: State Diagram graphics can't be read with Dark Theme / Dark Mode on Github

2 participants