From 7a4b3c5ce6ac1f71b1eb0efb586f58736a0e689f Mon Sep 17 00:00:00 2001
From: JRVector9 <jinwooroel@gmail.com>
Date: Mon, 6 Jul 2026 15:53:59 +0900
Subject: [PATCH] docs: mark unreleased storage backends and mosaic feature

getting-started.md documents storage-cos, storage-azdls, storage-obs,
storage-gcs, and mosaic as available under paimon = { version = "0.2.0" },
but none of these features exist in the published 0.2.0 crate. They were
added on main after the 0.2.0 release. Following the docs literally with
a version-pinned dependency fails to build.

Mark these features as main-branch-only and switch their example
snippets to a git dependency, which does build against main.

Fixes #461
---
 docs/src/getting-started.md | 19 +++++++++++++------
 1 file changed, 13 insertions(+), 6 deletions(-)

diff --git a/docs/src/getting-started.md b/docs/src/getting-started.md
index a5c07577..b0317e53 100644
--- a/docs/src/getting-started.md
+++ b/docs/src/getting-started.md
@@ -44,20 +44,27 @@ Available storage features:
 | `storage-memory` | In-memory        |
 | `storage-s3`     | Amazon S3        |
 | `storage-oss`    | Alibaba Cloud OSS|
-| `storage-cos`    | Tencent Cloud COS|
-| `storage-azdls`  | Azure Data Lake Storage Gen2 |
-| `storage-obs`    | Huawei Cloud OBS |
-| `storage-gcs`    | Google Cloud Storage |
+| `storage-cos`    | Tencent Cloud COS <sup>[1]</sup> |
+| `storage-azdls`  | Azure Data Lake Storage Gen2 <sup>[1]</sup> |
+| `storage-obs`    | Huawei Cloud OBS <sup>[1]</sup> |
+| `storage-gcs`    | Google Cloud Storage <sup>[1]</sup> |
 | `storage-hdfs`   | HDFS             |
 | `storage-all`    | All of the above |
 
+<sup>[1]</sup> Not in the latest release yet; available on the `main` branch. To use it now, depend on the git repository instead of a published version:
+
+```toml
+[dependencies]
+paimon = { git = "https://github.com/apache/paimon-rust", features = ["storage-cos"] }
+```
+
 ## Optional File Formats
 
-Mosaic data files can be read by enabling the `mosaic` feature:
+Mosaic data files can be read by enabling the `mosaic` feature. This feature is not in the latest release yet; it is available on the `main` branch:
 
 ```toml
 [dependencies]
-paimon = { version = "0.2.0", features = ["mosaic"] }
+paimon = { git = "https://github.com/apache/paimon-rust", features = ["mosaic"] }
 ```
 
 The current Mosaic support is read-only. Paimon Rust can read existing `.mosaic` data files in a Paimon table, but it does not write Mosaic data files yet.