Open
Conversation
Contributor
Author
|
@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? |
leekeiabstraction
force-pushed
the
client-docs-website
branch
from
88dfc65 to
618109b
Compare
There was a problem hiding this comment.
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
.gitignorefor 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.
Comment on lines
+1
to
+3
| import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; | ||
|
|
||
| const sidebars: SidebarsConfig = { |
There was a problem hiding this comment.
This sidebar config is missing the standard ASF license header comment at the top. The repository enforces license headers via CI; please add the header to this file.
Comment on lines
+1
to
+6
| --- | ||
| slug: / | ||
| sidebar_position: 1 | ||
| title: Introduction | ||
| --- | ||
|
|
There was a problem hiding this comment.
This documentation page is missing the ASF license header (the repo’s other Markdown docs start with the ASF header as an HTML comment, and CI checks headers). Please add the header here (and consistently across the other new website/docs/**.md pages).
Contributor
|
@leekeiabstraction Thanks for the great work. It look well! |
leekeiabstraction
force-pushed
the
client-docs-website
branch
from
618109b to
f2f83f4
Compare
Contributor
Author
|
@luoyuxia @fresh-borzoni Appreciate your reviews here |
Contributor
Author
|
I will update this again after #302 is merged |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Linked issue: close #299 #284
Brief change log
Example on how it looks: