Client doc website by leekeiabstraction · Pull Request #300 · apache/fluss-rust

leekeiabstraction · 2026-02-10T22:32:34Z

Purpose

Linked issue: close #299 #284

Brief change log

Added docusaurus style client documentation website (tried but opted not to use bookmd because I cannot make the theme consistent with main website

Example on how it looks:

leekeiabstraction · 2026-02-10T22:34:05Z

@luoyuxia This is a first draft, can you check if this structuring is OK before I move onto polishing / port over the content from existing docs?

Copilot

Pull request overview

Adds a Docusaurus-based documentation website under website/ to host client documentation (Rust/Python/C++) for the fluss-rust repository, along with assets, styling, and sidebar/navigation configuration.

Changes:

Introduces a Docusaurus site (config, sidebar, TypeScript config, build scripts, dependencies).
Adds client documentation pages for Rust, Python, and C++ plus developer-guide content.
Adds website branding assets and custom CSS aligned with the main Fluss site; updates .gitignore for website build artifacts.

Reviewed changes

Copilot reviewed 38 out of 42 changed files in this pull request and generated 14 comments.

Show a summary per file

File	Description
`.gitignore`	Ignores Docusaurus build/artifact directories and fixes CMake ignore indentation.
`website/babel.config.js`	Adds Babel preset config for Docusaurus.
`website/docusaurus.config.ts`	Core Docusaurus site configuration (navbar, prism, baseUrl, editUrl, etc.).
`website/package.json`	Adds Node dependencies/scripts for building and serving the docs site.
`website/sidebars.ts`	Defines sidebar structure (User Guide autogenerated + Developer Guide).
`website/src/css/custom.css`	Custom styling to match main Fluss website.
`website/static/img/logo/png/colored_logo.png`	Adds logo image asset.
`website/static/img/logo/svg/colored_logo.svg`	Adds SVG logo asset (includes ASF header).
`website/static/img/logo/fluss_favicon.svg`	Adds favicon SVG asset (includes ASF header).
`website/tsconfig.json`	Adds TS config extending Docusaurus defaults.
`website/docs/index.md`	Site landing page (client overview and guide structure).
`website/docs/user-guide/_category_.json`	Creates “User Guide” doc category metadata.
`website/docs/user-guide/rust/_category_.json`	Creates “Rust” subcategory metadata.
`website/docs/user-guide/rust/installation.md`	Rust installation instructions and feature flags.
`website/docs/user-guide/rust/example.md`	Rust quickstart example.
`website/docs/user-guide/rust/configuration.md`	Rust client configuration reference.
`website/docs/user-guide/rust/admin-operations.md`	Rust admin API examples.
`website/docs/user-guide/rust/log-tables.md`	Rust log-table usage guide.
`website/docs/user-guide/rust/primary-key-tables.md`	Rust primary-key (KV) table usage guide.
`website/docs/user-guide/rust/partitioned-tables.md`	Rust partitioned table usage guide.
`website/docs/user-guide/rust/data-types.md`	Rust data type mapping reference.
`website/docs/user-guide/python/_category_.json`	Creates “Python” subcategory metadata.
`website/docs/user-guide/python/installation.md`	Python bindings installation/build-from-source guide.
`website/docs/user-guide/python/example.md`	Python quickstart example.
`website/docs/user-guide/python/configuration.md`	Python client configuration reference.
`website/docs/user-guide/python/admin-operations.md`	Python admin API examples.
`website/docs/user-guide/python/log-tables.md`	Python log-table usage guide.
`website/docs/user-guide/python/primary-key-tables.md`	Python primary-key (KV) table usage guide.
`website/docs/user-guide/python/partitioned-tables.md`	Python partitioned table usage guide.
`website/docs/user-guide/python/data-types.md`	Python data type mapping reference.
`website/docs/user-guide/cpp/_category_.json`	Creates “C++” subcategory metadata.
`website/docs/user-guide/cpp/installation.md`	C++ bindings build/install instructions.
`website/docs/user-guide/cpp/example.md`	C++ quickstart example.
`website/docs/user-guide/cpp/configuration.md`	C++ configuration/error-handling guide.
`website/docs/user-guide/cpp/admin-operations.md`	C++ admin API examples.
`website/docs/user-guide/cpp/log-tables.md`	C++ log-table usage guide.
`website/docs/user-guide/cpp/primary-key-tables.md`	C++ primary-key (KV) table usage guide.
`website/docs/user-guide/cpp/partitioned-tables.md`	C++ partitioned table usage guide.
`website/docs/user-guide/cpp/data-types.md`	C++ data type mapping reference.
`website/docs/developer-guide/_category_.json`	Creates “Developer Guide” doc category metadata.
`website/docs/developer-guide/contributing.md`	Contributor/dev setup instructions for repo.
`website/docs/developer-guide/release.md`	Release process documentation for clients.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

website/sidebars.ts

website/docs/index.md

website/docs/user-guide/python/primary-key-tables.md

website/docs/user-guide/python/partitioned-tables.md

website/package.json

website/babel.config.js

website/docs/user-guide/python/primary-key-tables.md

website/docs/user-guide/python/log-tables.md

website/docs/user-guide/python/example.md

luoyuxia · 2026-02-11T08:09:47Z

@leekeiabstraction Thanks for the great work. It look well!

leekeiabstraction · 2026-02-11T21:54:34Z

@luoyuxia @fresh-borzoni Appreciate your reviews here

leekeiabstraction · 2026-02-12T09:00:12Z

I will update this again after #302 is merged

leekeiabstraction · 2026-02-12T22:50:49Z

Rebased and updated doc according to latest API changes, appreciate a review here @luoyuxia @fresh-borzoni

leekeiabstraction · 2026-02-13T13:20:05Z

Updated doc to include changes from unsubscribe APIs as well.

fresh-borzoni

@leekeiabstraction Ty for the PR. Took a while to take a look
Left some comments. PTAL.

I will address code inconsistencies and let you know about some of the comments. And then we'll run another round of review, probably we'll spot something else.

website/docs/user-guide/python/error-handling.md

website/docs/user-guide/python/api-reference.md

website/docs/user-guide/python/example/configuration.md

website/docs/user-guide/rust/example/admin-operations.md

website/docs/user-guide/rust/example/partitioned-tables.md

website/docs/user-guide/cpp/example/admin-operations.md

website/docs/user-guide/cpp/api-reference.md

website/docs/user-guide/cpp/data-types.md

website/docs/user-guide/cpp/api-reference.md

fresh-borzoni · 2026-02-13T16:56:49Z

Also we may wish to specify default precision for Timestamps - it's 6. It might be important.

fresh-borzoni · 2026-02-13T19:24:29Z

@leekeiabstraction I created #313 to address inconsistencies found while reviewing doc

luoyuxia

@leekeiabstraction Thanks for the great work. It looks good to me overall. For any document miss, we can add in following pr. Let's just merge it before it becomes too big...

Few more comments here:

Add a readme for website to include how to build, just like java repo?
seems read me is generate , maybe we can just remove readme now since website already include it? It's hard to maintail two copy of context although one is just generated.

bindings/cpp/README.md

.github/workflows/release_python.yml

website/docs/developer-guide/release.md

luoyuxia

After build the website, left more comments.
Btw, with the website, our fluss-rust project looks more attractive.

website/docs/index.md

website/docs/user-guide/cpp/example/configuration.md

website/docs/user-guide/python/installation.md

website/docs/user-guide/python/example/log-tables.md

# Conflicts: # bindings/python/README.md # docs/rust-client.md # Conflicts: # docs/rust-client.md

…isn't handle by server. Formatting.

leekeiabstraction · 2026-02-14T23:24:36Z

Thank you both for the diligent and tireless reviews 🙏! I've addressed most comments. Let's get this merged and we can address further changes in smaller PRs.

luoyuxia

@fresh-borzoni Hi, do you have further comments.

fresh-borzoni · 2026-02-15T00:58:42Z

No comments, we'd better merge

luoyuxia

Thank @leekeiabstraction . LGTM to me

leekeiabstraction force-pushed the client-docs-website branch from 88dfc65 to 618109b Compare February 10, 2026 22:37

luoyuxia requested a review from Copilot February 11, 2026 01:43

Copilot started reviewing on behalf of luoyuxia February 11, 2026 01:43 View session

luoyuxia self-requested a review February 11, 2026 01:44

Copilot AI reviewed Feb 11, 2026

View reviewed changes

leekeiabstraction force-pushed the client-docs-website branch from 618109b to f2f83f4 Compare February 11, 2026 21:45

leekeiabstraction marked this pull request as ready for review February 11, 2026 21:54

leekeiabstraction force-pushed the client-docs-website branch from f2f83f4 to 7f52dac Compare February 12, 2026 22:48

leekeiabstraction force-pushed the client-docs-website branch from 7f52dac to abe9327 Compare February 13, 2026 13:19

fresh-borzoni reviewed Feb 13, 2026

View reviewed changes

luoyuxia reviewed Feb 14, 2026

View reviewed changes

bindings/cpp/README.md Show resolved Hide resolved

.github/workflows/release_python.yml Show resolved Hide resolved

website/docs/developer-guide/release.md Outdated Show resolved Hide resolved

luoyuxia reviewed Feb 14, 2026

View reviewed changes

leekeiabstraction added 5 commits February 14, 2026 23:05

Restructure client documentations, now using docusaurus

afe77a2

# Conflicts: # bindings/python/README.md # docs/rust-client.md # Conflicts: # docs/rust-client.md

Update draft doc

5aacae2

Update draft doc

d084911

Update following unsubscribe API changes. Remove LATEST_OFFSET which …

70f0484

…isn't handle by server. Formatting.

Address comments

e8cdd82

leekeiabstraction force-pushed the client-docs-website branch from abe9327 to e8cdd82 Compare February 14, 2026 23:09

Fix issue after moiving release page

d6bc98c

luoyuxia reviewed Feb 15, 2026

View reviewed changes

luoyuxia approved these changes Feb 15, 2026

View reviewed changes

luoyuxia merged commit eaadb3f into apache:main Feb 15, 2026
13 checks passed

leekeiabstraction mentioned this pull request Feb 15, 2026

Add missed API documentation update #337

Open

Conversation

leekeiabstraction commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Brief change log

Uh oh!

leekeiabstraction commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

luoyuxia commented Feb 11, 2026

Uh oh!

leekeiabstraction commented Feb 11, 2026

Uh oh!

leekeiabstraction commented Feb 12, 2026

Uh oh!

leekeiabstraction commented Feb 12, 2026

Uh oh!

leekeiabstraction commented Feb 13, 2026

Uh oh!

fresh-borzoni left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fresh-borzoni commented Feb 13, 2026

Uh oh!

fresh-borzoni commented Feb 13, 2026

Uh oh!

luoyuxia left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

luoyuxia left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

leekeiabstraction commented Feb 14, 2026

Uh oh!

luoyuxia left a comment

Choose a reason for hiding this comment

Uh oh!

fresh-borzoni commented Feb 15, 2026

Uh oh!

luoyuxia left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

leekeiabstraction commented Feb 10, 2026 •

edited

Loading

leekeiabstraction commented Feb 10, 2026 •

edited

Loading

luoyuxia left a comment •

edited

Loading