Skip to content

[website]add theme-aware images and fix broken links#3497

Open
Prajwal-banakar wants to merge 3 commits into
apache:mainfrom
Prajwal-banakar:theme-aware-diagrams
Open

[website]add theme-aware images and fix broken links#3497
Prajwal-banakar wants to merge 3 commits into
apache:mainfrom
Prajwal-banakar:theme-aware-diagrams

Conversation

@Prajwal-banakar

@Prajwal-banakar Prajwal-banakar commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Purpose

Linked issue: close #3496

The purpose of this change is to improve the readability and visual consistency of the documentation website by implementing theme-aware diagrams that adapt to the user's selected light or dark mode. This also resolves multiple broken link warnings that occurred after renaming files.

Brief change log

  • Created ThemedImage.js component: A new reusable React component was added in website/src/components/ to handle the logic for displaying different images based on the current theme.
  • Added Light-Theme Images: New *-light.png versions of existing diagrams were added to website/docs/assets/.
  • Converted .md to .mdx: Several documentation files containing diagrams were renamed from Markdown to MDX to allow the use of React components.
  • Implemented Themed Images: Replaced standard markdown image tags with the new <ThemedImage> component in the updated .mdx files.
  • Fixed Broken Links: Updated internal links across multiple documentation files (client-support-matrix.md, getting-started.md, intro.mdx, etc.) to point to the new .mdx file paths, resolving all build warnings.

Tests

  • Manually verified that diagrams on all modified pages render correctly.
  • Confirmed that images switch automatically when toggling between light and dark modes on the website.
  • Ran the development server (npm run start) and verified that all "couldn't be resolved" warnings related to broken links have been eliminated from the build output.

API and Format

No, this change does not affect any public APIs or storage formats. It is a documentation-only enhancement.

Documentation

Yes, this change enhances the existing documentation by improving its visual presentation and fixing navigational issues caused by broken links.

@Prajwal-banakar

Copy link
Copy Markdown
Contributor Author

@wuchong @polyzos PTAL when you have some time! Thanks,

@binary-signal binary-signal left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM. One minor thing I noticed: in the light theme, the search bar seems to use the same opacity as the dark theme, which makes it look a bit too transparent. The hover state looks good, so it might be worth disabling or reducing the transparency for the default state in the light theme.

On hover
Image

Not on hover
Image

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.

[website]Implement Theme-Aware Images for Documentation

2 participants