docs: document the applicability of all yazi-* crates (#3345)

Author: sxyazi

Cargo.lock

@@ -24,7 +24,7 @@ ansi-to-tui         = "7.0.0"
 anyhow              = "1.0.100"
 base64              = "0.22.1"
 bitflags            = { version = "2.10.0", features = [ "serde" ] }
-clap                = { version = "4.5.51", features = [ "derive" ] }
+clap                = { version = "4.5.53", features = [ "derive" ] }
 core-foundation-sys = "0.8.7"
 crossterm           = { version = "0.29.0", features = [ "event-stream" ] }
 dirs                = "6.0.0"

Cargo.toml

@@ -0,0 +1,5 @@
+# yazi-actor
+
+This crate is part of [Yazi][source], and it is not supposed to be used outside, as there are no guarantees about the stability of its API.
+
+[source]: https://github.com/sxyazi/yazi

yazi-actor/README.md

@@ -20,9 +20,9 @@ ansi-to-tui = { workspace = true }
 anyhow      = { workspace = true }
 base64      = { workspace = true }
 crossterm   = { workspace = true }
-image       = { version = "0.25.8", default-features = false, features = [ "avif", "bmp", "dds", "exr", "ff", "gif", "hdr", "ico", "jpeg", "png", "pnm", "qoi", "tga", "webp" ] }
+image       = { version = "0.25.9", default-features = false, features = [ "avif", "bmp", "dds", "exr", "ff", "gif", "hdr", "ico", "jpeg", "png", "pnm", "qoi", "tga", "webp" ] }
 palette     = { version = "0.7.6", default-features = false }
-quantette   = { version = "0.3.0", default-features = false }
+quantette   = { version = "0.5.1", default-features = false }
 ratatui     = { workspace = true }
 scopeguard  = { workspace = true }
 tokio       = { workspace = true }

yazi-adapter/Cargo.toml

@@ -0,0 +1,5 @@
+# yazi-adapter
+
+This crate is part of [Yazi][source], and it is not supposed to be used outside, as there are no guarantees about the stability of its API.
+
+[source]: https://github.com/sxyazi/yazi

yazi-adapter/README.md

@@ -4,13 +4,18 @@ use anyhow::{Result, bail};
 use crossterm::{cursor::MoveTo, queue};
 use image::{DynamicImage, GenericImageView, RgbImage};
 use palette::{Srgb, cast::ComponentsAs};
-use quantette::{ColorSlice, PaletteSize, QuantizeOutput, wu::UIntBinner};
+use quantette::{PaletteSize, color_map::IndexedColorMap, wu::{BinnerU8x3, WuU8x3}};
 use ratatui::layout::Rect;
 
 use crate::{CLOSE, ESCAPE, Emulator, Image, START, adapter::Adapter};
 
 pub(crate) struct Sixel;
 
+struct QuantizeOutput<T> {
+	indices: Vec<u8>,
+	palette: Vec<T>,
+}
+
 impl Sixel {
 	pub(crate) async fn image_show(path: PathBuf, max: Rect) -> Result<Rect> {
 		let img = Image::downscale(path, max).await?;
@@ -110,12 +115,14 @@ impl Sixel {
 
 	fn quantify(rgb: &RgbImage, alpha: bool) -> Result<QuantizeOutput<Srgb<u8>>> {
 		let buf = &rgb.as_raw()[..(rgb.pixels().len() * 3)];
-		let slice: ColorSlice<Srgb<u8>> = buf.components_as().try_into()?;
+		let colors: &[Srgb<u8>] = buf.components_as();
 
-		Ok(quantette::wu::indexed_palette(
-			&slice,
-			PaletteSize::try_from(256u16 - alpha as u16)?,
-			&UIntBinner::<32>,
-		))
+		let wu = WuU8x3::run_slice(colors, BinnerU8x3::rgb())?;
+		let color_map = wu.color_map(PaletteSize::try_from(256u16 - alpha as u16)?);
+
+		Ok(QuantizeOutput {
+			indices: color_map.map_to_indices(colors),
+			palette: color_map.into_palette().into_vec(),
+		})
 	}
 }

yazi-adapter/src/drivers/sixel.rs

@@ -0,0 +1,5 @@
+# yazi-binding
+
+This crate is part of [Yazi][source], and it is not supposed to be used outside, as there are no guarantees about the stability of its API.
+
+[source]: https://github.com/sxyazi/yazi

yazi-binding/README.md

@@ -28,7 +28,7 @@ yazi-shared = { path = "../yazi-shared", version = "25.9.15" }
 
 # External dependencies
 clap                  = { workspace = true }
-clap_complete         = "4.5.60"
+clap_complete         = "4.5.61"
 clap_complete_fig     = "4.5.2"
 clap_complete_nushell = "4.5.10"
 vergen-gitcl          = { version = "1.0.8", features = [ "build", "rustc" ] }

yazi-boot/Cargo.toml

@@ -0,0 +1,5 @@
+# yazi-boot
+
+This crate is part of [Yazi][source], and it is not supposed to be used outside, as there are no guarantees about the stability of its API.
+
+[source]: https://github.com/sxyazi/yazi

yazi-boot/README.md

@@ -0,0 +1,5 @@
+# yazi-build
+
+This crate is part of [Yazi][source], and it is not supposed to be used outside, as there are no guarantees about the stability of its API.
+
+[source]: https://github.com/sxyazi/yazi