Prajwal-banakar opened a new pull request, #2462:
URL: https://github.com/apache/fluss/pull/2462
<!--
*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
- 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.
- 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.
- 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.
- Make sure that the change passes the automated tests, i.e., `mvn clean
verify` passes.
- Each pull request should address only one issue, not mix up code from
multiple issues.
**(The sections below can be removed for hotfixes or typos)**
-->
### Purpose
<!-- Linking this pull request to the issue -->
Linked issue: close #2446
<!-- What is the purpose of the change -->
The purpose of this change is to provide comprehensive documentation for the
Fluss Rust Client. This helps Rust developers understand how to interact with
the Fluss cluster, manage resources, and perform high-performance data
operations.
### Brief change log
<!-- Please describe the changes made in this pull request and explain how
they address the issue -->
This pull request introduces the following changes:
New Documentation: Created website/docs/apis/rust-client.md based on the
existing Java client structure.
Rust Snippets: Added asynchronous code examples for initialization using
Tokio, Admin API usage, and Table API operations (Writers/Scanners/Lookups).
Type Mapping: Included a dedicated section mapping Fluss internal types to
native Rust types.
Sidebar Hierarchy: Configured the sidebar to display the Rust Client
immediately following the Python Client.
Build Metadata: Updated website/package-lock.json to ensure consistency in
the website build environment.
### Tests
<!-- List UT and IT cases to verify this change -->
Manual UI Verification: The documentation was built locally using the
Docusaurus development server.
Rendering Check: Confirmed that all Rust syntax highlighting, tables, and
sidebar navigation items display correctly at localhost:3000.
After changes
<img width="1920" height="1080" alt="Screenshot 2026-01-24 111617"
src="https://github.com/user-attachments/assets/1a28e758-54d3-4a2f-acb5-bd6febd009f9";
/>
### API and Format
<!-- Does this change affect API or storage format -->
This change is documentation-only and does not affect the API or storage
format of the Fluss server or clients.
### Documentation
<!-- Does this change introduce a new feature -->
This PR introduces a new documentation page for the Fluss Rust Client.
--
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]
