[docs] Add C++ client documentation#2923
Open
Prajwal-banakar wants to merge 2 commits intoapache:mainfrom
Open
[docs] Add C++ client documentation#2923Prajwal-banakar wants to merge 2 commits intoapache:mainfrom
Prajwal-banakar wants to merge 2 commits intoapache:mainfrom
Conversation
Contributor
leekeiabstraction
left a comment
leekeiabstraction
left a comment
There was a problem hiding this comment.
TY, mostly LGTM. Left a comment. PTAL.
|
|
||
| The C++ client is not yet published as a package and must be built from source. | ||
|
|
||
| **Prerequisites:** CMake 3.22+, C++17 compiler, Rust 1.85+, Apache Arrow C++ library |
Contributor
There was a problem hiding this comment.
C++ build from source is slightly more involved with dependencies installation needed as well. Can we either add steps to install those and / or link to main doc e.g. see also steps to install pre-requisites
Contributor
Author
There was a problem hiding this comment.
I've added the dependency installation steps for macOS and Ubuntu/Debian, and linked to the full installation guide for advanced options like CMake FetchContent integration. PTAL!
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 #2448
This PR adds a lightweight documentation page for the Fluss C++ Client, following the same pattern as the recently merged Rust (#2462) and Python (#2461) client documentation PRs.
Brief change log
Tests
Manual verification using the Docusaurus development server page renders correctly and appears in the correct sidebar position.
API and Format
Documentation only. No API or storage format changes.
Documentation
Adds new page for C++ client