Prajwal-banakar opened a new pull request, #3497:
URL: https://github.com/apache/fluss/pull/3497
<!--
*Thank you very much for contributing to Fluss - we are happy that you want
to help us improve Fluss. To help the community review your contribution in the
best possible way, please go through the checklist below, which will get the
contribution into a shape in which it can be best reviewed.*
## Contribution Checklist
- [X] Make sure that the pull request corresponds to a [GitHub
issue](https://github.com/apache/fluss/issues). Exceptions are made for typos
in JavaDoc or documentation files, which need no issue.
- [X] Name the pull request in the format "[component] Title of the pull
request", where *[component]* should be replaced by the name of the component
being changed. Typically, this corresponds to the component label assigned to
the issue (e.g., [kv], [log], [client], [flink]). Skip *[component]* if you are
unsure about which is the best component.
- [X] Fill out the template below to describe the changes contributed by
the pull request. That will give reviewers the context they need to do the
review.
- [X] Make sure that the change passes the automated tests, i.e., `mvn
clean verify` passes.
- [X] Each pull request should address only one issue, not mix up code
from multiple issues.
- **Generative AI disclosure:** Indicate whether generative AI tools were
used in authoring this PR. If yes, specify the tool below.
- [ ] No generative AI tools used
- [X] Yes (please specify the tool below)
**(The sections below can be removed for hotfixes or typos)**
-->
Generated-by: Google's AI developer assistant following the guidelines
### Purpose
<!-- Linking this pull request to the issue -->
Linked issue: close #3496
<!-- What is the purpose of the change -->
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
<!-- Please describe the changes made in this pull request and explain how
they address the issue -->
- **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
<!-- List UT and IT cases to verify this change -->
- 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
<!-- Does this change affect API or storage format -->
No, this change does not affect any public APIs or storage formats. It is a
documentation-only enhancement.
### Documentation
<!-- Does this change introduce a new feature -->
Yes, this change enhances the existing documentation by improving its visual
presentation and fixing navigational issues caused by broken links.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
