From 750d183843ccc0e10f52078eda07e2639af3f803 Mon Sep 17 00:00:00 2001
From: Lachlan Deakin <ljdgit@gmail.com>
Date: Sun, 20 Oct 2024 15:01:10 +1100
Subject: [PATCH] Cleanup `stores.md` and associated root docs

---
 zarrs/doc/status/stores.md |  9 ++++++---
 zarrs/src/lib.rs           | 16 +++++++++++++---
 2 files changed, 19 insertions(+), 6 deletions(-)

diff --git a/zarrs/doc/status/stores.md b/zarrs/doc/status/stores.md
index e2473d30..c421c533 100644
--- a/zarrs/doc/status/stores.md
+++ b/zarrs/doc/status/stores.md
@@ -5,17 +5,18 @@
 | [OpendalStore]                     |        | &check;* | &check;* | &check;* | &check; |         | [zarrs_opendal]                |
 | [AsyncOpendalStore]                |        | &check;* | &check;* | &check;* |         | &check; | [zarrs_opendal]                |
 | [AsyncObjectStore]                 |        | &check;* | &check;* | &check;* |         | &check; | [zarrs_object_store]           |
+| [AsyncIcechunkStore]               |        | &check;* | &check;* | &check;* |         | &check; | [zarrs_icechunk]               |
 | [HTTPStore]                        |        | &check;  |          |          | &check; |         | [zarrs_http]                   |
 | [AsyncToSyncStorageAdapter]        |        | &check;  | &check;  | &check;  | &check; | &check; | [zarrs_storage]<sup>†</sup>    |
 | [UsageLogStorageAdapter]           |        | &check;  | &check;  | &check;  | &check; | &check; | [zarrs_storage]<sup>†</sup>    |
 | [PerformanceMetricsStorageAdapter] |        | &check;  | &check;  | &check;  | &check; | &check; | [zarrs_storage]<sup>†</sup>    |
 | [ZipStorageAdapter]                |        | &check;  |          | &check;  | &check; |         | [zarrs_zip]                    |
 
-<sup>† Re-exported in the `zarrs::storage` module</sup>
+<sup>† Re-exported in the `zarrs::storage` module.</sup>
 <br>
-<sup>‡ Re-exported as the `zarrs::filesystem` module</sup>
+<sup>‡ Re-exported as the `zarrs::filesystem` module.</sup>
 <br>
-<sup>\* Support depends on the [`opendal`](https://docs.rs/opendal/latest/opendal/) [`BlockingOperator`](https://docs.rs/opendal/latest/opendal/struct.BlockingOperator.html)/[`Operator`](https://docs.rs/opendal/latest/opendal/struct.Operator.html) or [`object_store`](https://docs.rs/object_store/latest/object_store/) [store](https://docs.rs/object_store/latest/object_store/index.html#modules).</sup>
+<sup>\* Support depends on the underlying store.</sup>
 
 [0001]: https://zarr.dev/zeps/accepted/ZEP0001.html
 
@@ -23,6 +24,7 @@
 [zarrs_filesystem]: https://docs.rs/zarrs_filesystem/latest/zarrs_filesystem/
 [zarrs_object_store]: https://docs.rs/zarrs_object_store/latest/zarrs_object_store/
 [zarrs_opendal]: https://docs.rs/zarrs_opendal/latest/zarrs_opendal/
+[zarrs_icechunk]: https://docs.rs/zarrs_icechunk/latest/zarrs_icechunk/
 [zarrs_http]: https://docs.rs/zarrs_http/latest/zarrs_http/
 [zarrs_zip]: https://docs.rs/zarrs_zip/latest/zarrs_zip/
 
@@ -31,6 +33,7 @@
 [OpendalStore]: https://docs.rs/zarrs_opendal/latest/zarrs_opendal/struct.OpendalStore.html
 [AsyncOpendalStore]: https://docs.rs/zarrs_opendal/latest/zarrs_opendal/struct.AsyncOpendalStore.html
 [AsyncObjectStore]: https://docs.rs/zarrs_object_store/latest/zarrs_object_store/struct.AsyncObjectStore.html
+[AsyncIcechunkStore]: https://docs.rs/zarrs_icechunk/latest/zarrs_icechunk/struct.AsyncIcechunkStore.html
 [HTTPStore]: https://docs.rs/zarrs_http/latest/zarrs_http/struct.HTTPStore.html
 
 [AsyncToSyncStorageAdapter]: crate::storage::storage_adapter::async_to_sync::AsyncToSyncStorageAdapter
diff --git a/zarrs/src/lib.rs b/zarrs/src/lib.rs
index 02e8094c..a2976063 100644
--- a/zarrs/src/lib.rs
+++ b/zarrs/src/lib.rs
@@ -66,11 +66,21 @@
 //!
 #![doc = include_str!("../doc/status/stores.md")]
 //!
-//! A huge range of storage backends are supported via the [`opendal`](https://docs.rs/opendal/latest/opendal/) and [`object_store`](https://docs.rs/opendal/latest/object_store/) crates.
-//! The documentation for the [zarrs_opendal] and [zarrs_object_store] crates includes version compatibility matrices with `zarrs` and the associated storage backends.
+//! A huge range of storage backends are supported via the [`opendal`] and [`object_store`] crates.
+//! The documentation for the [`zarrs_opendal`] and [`zarrs_object_store`] crates includes version compatibility matrices with `zarrs` and the associated storage backends.
 //! These backends provide more feature complete HTTP stores than [zarrs_http].
 //!
-//! Asynchronous stores can be used in a synchronous context with the [`AsyncToSyncStorageAdapter`](crate::storage::storage_adapter::async_to_sync::AsyncToSyncStorageAdapter).
+//! [`zarrs_icechunk`] implements the [Icechunk](https://icechunk.io/overview/) transactional storage engine, a storage specification for Zarr.
+//! It supports [`object_store`] stores.
+//!
+//! [`opendal`]: https://docs.rs/opendal/latest/opendal/
+//! [`object_store`]: https://docs.rs/object_store/latest/object_store/
+//! [`object_store`]: https://docs.rs/object_store/latest/object_store/
+//! [`zarrs_icechunk`]: https://docs.rs/zarrs_icechunk/latest/zarrs_icechunk/
+//! [`zarrs_object_store`]: https://docs.rs/zarrs_object_store/latest/zarrs_object_store/
+//! [`zarrs_opendal`]: https://docs.rs/zarrs_opendal/latest/zarrs_opendal/
+//!
+//! The [`AsyncToSyncStorageAdapter`](crate::storage::storage_adapter::async_to_sync::AsyncToSyncStorageAdapter) enables some async stores to be used in a sync context.
 //!
 //! ## Examples
 #![cfg_attr(feature = "ndarray", doc = "```rust")]