Tweak documentation

README.md

@@ -37,6 +37,9 @@ cargo run -- --env=dev
 | [`zino-core`]   | Core types and traits. | [![Crates.io](https://img.shields.io/crates/v/zino-core)][zino-core] | [![Documentation](https://shields.io/docsrs/zino-core)][zino-core-docs] |
 | [`zino-derive`] | Derived traits.        | [![Crates.io](https://img.shields.io/crates/v/zino-derive)][zino-derive] | [![Documentation](https://shields.io/docsrs/zino-derive)][zino-derive-docs] |
 | [`zino-model`]  | Domain models.         | [![Crates.io](https://img.shields.io/crates/v/zino-model)][zino-model] | [![Documentation](https://shields.io/docsrs/zino-model)][zino-model-docs] |
+| [`zino-extra`]  | Extra utilities.       | [![Crates.io](https://img.shields.io/crates/v/zino-extra)][zino-extra] | [![Documentation](https://shields.io/docsrs/zino-extra)][zino-extra-docs] |
+| [`zino-dioxus`] | Dioxus components.     | [![Crates.io](https://img.shields.io/crates/v/zino-dioxus)][zino-dioxus] | [![Documentation](https://shields.io/docsrs/zino-dioxus)][zino-dioxus-docs] |
+| [`zino-cli`]    | CLI tool.              | [![Crates.io](https://img.shields.io/crates/v/zino-cli)][zino-cli] | [![Documentation](https://shields.io/docsrs/zino-cli)][zino-cli-docs] |
 
 ## License
 
@@ -52,6 +55,9 @@ For Chinese rustaceans, you can also follow our WeChat official account to canta
 [`zino-core`]: https://github.com/photino/zino/tree/main/zino-core
 [`zino-derive`]: https://github.com/photino/zino/tree/main/zino-derive
 [`zino-model`]: https://github.com/photino/zino/tree/main/zino-model
+[`zino-extra`]: https://github.com/photino/zino/tree/main/zino-extra
+[`zino-dioxus`]: https://github.com/photino/zino/tree/main/zino-dioxus
+[`zino-cli`]: https://github.com/photino/zino/tree/main/zino-cli
 [zino]: https://crates.io/crates/zino
 [zino-docs]: https://docs.rs/zino
 [zino-core]: https://crates.io/crates/zino-core
@@ -60,6 +66,12 @@ For Chinese rustaceans, you can also follow our WeChat official account to canta
 [zino-derive-docs]: https://docs.rs/zino-derive
 [zino-model]: https://crates.io/crates/zino-model
 [zino-model-docs]: https://docs.rs/zino-model
+[zino-extra]: https://crates.io/crates/zino-extra
+[zino-extra-docs]: https://docs.rs/zino-extra
+[zino-dioxus]: https://crates.io/crates/zino-dioxus
+[zino-dioxus-docs]: https://docs.rs/zino-dioxus
+[zino-cli]: https://crates.io/crates/zino-cli
+[zino-cli-docs]: https://docs.rs/zino-cli
 [`sqlx`]: https://crates.io/crates/sqlx
 [`tracing`]: https://crates.io/crates/tracing
 [`metrics`]: https://crates.io/crates/metrics

examples/dioxus-desktop/src/view/overview.rs

@@ -2,12 +2,17 @@ use dioxus::prelude::*;
 use dioxus_free_icons::{icons::go_icons::*, Icon};
 
 pub fn Overview(cx: Scope) -> Element {
-    let data = [
+    let core_crates = [
         ("zino", "Framework integrations."),
         ("zino-core", "Core types and traits."),
         ("zino-derive", "Derived traits."),
         ("zino-model", "Domain models."),
     ];
+    let extra_crates = [
+        ("zino-extra", "Extra utilities."),
+        ("zino-dioxus", "Dioxus components."),
+        ("zino-cli", "CLI tools."),
+    ];
     render! {
         div {
             class: "columns is-6",
@@ -195,52 +200,71 @@ pub fn Overview(cx: Scope) -> Element {
         }
         div {
             class: "columns is-6",
-            for d in data {
-                div {
-                    class: "column",
+            for d in core_crates {
+                CrateListing {
+                    name: d.0,
+                    description: d.1,
+                }
+            }
+        }
+        div {
+            class: "columns is-6",
+            for d in extra_crates {
+                CrateListing {
+                    name: d.0,
+                    description: d.1,
+                }
+            }
+        }
+    }
+}
+
+#[inline_props]
+fn CrateListing<'a>(cx: Scope<'a>, name: &'a str, description: &'a str) -> Element {
+    render! {
+        div {
+            class: "column is-one-quarter",
+            div {
+                class: "card",
+                header {
+                    class: "card-header",
                     div {
-                        class: "card",
-                        header {
-                            class: "card-header",
-                            div {
-                                class: "card-header-title",
-                                span {
-                                    class: "tag is-warning is-light mr-1",
-                                    "{d.0}"
-                                }
-                                span { "{d.1}" }
-                            }
+                        class: "card-header-title",
+                        span {
+                            class: "tag is-warning is-light mr-1",
+                            "{name}"
                         }
-                        div {
-                            class: "card-content",
-                            a {
-                                class: "mr-2",
-                                href: "https://crates.io/crates/{d.0}",
-                                img {
-                                    src: "https://img.shields.io/crates/v/{d.0}",
-                                }
-                            }
-                            a {
-                                class: "mr-2",
-                                href: "https://docs.rs/{d.0}",
-                                img {
-                                    src: "https://shields.io/docsrs/{d.0}",
-                                }
-                            }
-                            img {
-                                class: "mr-2",
-                                src: "https://img.shields.io/crates/l/{d.0}",
-                            }
-                            img {
-                                class: "mr-2",
-                                src: "https://img.shields.io/crates/d/{d.0}"
-                            }
-                            img {
-                                class: "mr-2",
-                                src: "https://img.shields.io/crates/dr/{d.0}"
-                            }
+                        span { "{description}" }
+                    }
+                }
+                div {
+                    class: "card-content",
+                    a {
+                        class: "mr-2",
+                        href: "https://crates.io/crates/{name}",
+                        img {
+                            src: "https://img.shields.io/crates/v/{name}",
                         }
                     }
+                    a {
+                        class: "mr-2",
+                        href: "https://docs.rs/{name}",
+                        img {
+                            src: "https://shields.io/docsrs/{name}",
+                        }
+                    }
+                    img {
+                        class: "mr-2",
+                        src: "https://img.shields.io/crates/l/{name}",
+                    }
+                    img {
+                        class: "mr-2",
+                        src: "https://img.shields.io/crates/d/{name}"
+                    }
+                    img {
+                        class: "mr-2",
+                        src: "https://img.shields.io/crates/dr/{name}"
+                    }
                 }
             }
         }

zino-cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "zino-cli"
-description = "CLI tool for zino."
+description = "CLI tools for zino."
 version = "0.0.1"
 edition = "2021"
 license = "MIT"

zino-cli/README.md

@@ -1,3 +1,11 @@
-# zino-cli
+[![github]](https://github.com/photino/zino)
+[![crates-io]](https://crates.io/crates/zino-cli)
+[![docs-rs]](https://docs.rs/zino-cli)
 
-CLI tool for zino.
+[github]: https://img.shields.io/badge/github-8da0cb?labelColor=555555&logo=github
+[crates-io]: https://img.shields.io/badge/crates.io-fc8d62?labelColor=555555&logo=rust
+[docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?labelColor=555555&logo=docs.rs
+
+CLI tools for [`zino`].
+
+[`zino`]: https://github.com/photino/zino

zino-cli/src/lib.rs

@@ -0,0 +1,5 @@
+#![doc = include_str!("../README.md")]
+#![doc(html_favicon_url = "https://photino.github.io/zino-docs-zh/assets/zino-logo.png")]
+#![doc(html_logo_url = "https://photino.github.io/zino-docs-zh/assets/zino-logo.svg")]
+
+#![forbid(unsafe_code)]

zino-cli/src/main.rs

@@ -1,5 +1,3 @@
-//! CLI tool for zino.
-
 fn main() {
     println!("Hello, zino!");
 }

zino-core/README.md

@@ -1,6 +1,12 @@
-# zino-core
+[![github]](https://github.com/photino/zino)
+[![crates-io]](https://crates.io/crates/zino-core)
+[![docs-rs]](https://docs.rs/zino-core)
 
-Core types and traits for zino.
+[github]: https://img.shields.io/badge/github-8da0cb?labelColor=555555&logo=github
+[crates-io]: https://img.shields.io/badge/crates.io-fc8d62?labelColor=555555&logo=rust
+[docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?labelColor=555555&logo=docs.rs
+
+Core types and traits for [`zino`].
 
 ## Feature flags
 

zino-core/src/lib.rs

@@ -1,51 +1,18 @@
-//! [![github]](https://github.com/photino/zino)
-//! [![crates-io]](https://crates.io/crates/zino-core)
-//! [![docs-rs]](https://docs.rs/zino-core)
-//!
-//! [github]: https://img.shields.io/badge/github-8da0cb?labelColor=555555&logo=github
-//! [crates-io]: https://img.shields.io/badge/crates.io-fc8d62?labelColor=555555&logo=rust
-//! [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?labelColor=555555&logo=docs.rs
-//!
-//! Core types and traits for [`zino`].
-//!
-//! ## Feature flags
-//!
-//! The following optional features are available:
-//!
-//! | Name                | Description                                            | Default? |
-//! |---------------------|--------------------------------------------------------|----------|
-//! | `accessor`          | Enables the data access layer built with [`opendal`].  | No       |
-//! | `cache`             | Enables the cache services.                            | No       |
-//! | `chatbot`           | Enables the chatbot services.                          | No       |
-//! | `connector`         | Enables the data source connectors.                    | No       |
-//! | `crypto-sm`         | Enables China's Standards of Encryption Algorithms.    | No       |
-//! | `format`            | Enables the support for common file formats.           | No       |
-//! | `orm`               | Enables the ORM for MySQL, PostgreSQL or **SQLite**.   | No       |
-//! | `runtime-async-std` | Enables the [`async-std`] runtime.                     | No       |
-//! | `runtime-tokio`     | Enables the [`tokio`] runtime.                         | Yes      |
-//! | `tls-native`        | Enables the [`native-tls`] TLS backend.                | No       |
-//! | `tls-rustls`        | Enables the [`rustls`] TLS backend.                    | Yes      |
-//! | `view`              | Enables the HTML template rendering.                   | No       |
-//!
-//! [`zino`]: https://github.com/photino/zino
-//! [`opendal`]: https://crates.io/crates/opendal
-//! [`async-std`]: https://crates.io/crates/async-std
-//! [`tokio`]: https://crates.io/crates/tokio
-//! [`native-tls`]: https://crates.io/crates/native-tls
-//! [`rustls`]: https://crates.io/crates/rustls
+#![doc = include_str!("../README.md")]
+#![doc(html_favicon_url = "https://photino.github.io/zino-docs-zh/assets/zino-logo.png")]
+#![doc(html_logo_url = "https://photino.github.io/zino-docs-zh/assets/zino-logo.svg")]
 
 #![allow(async_fn_in_trait)]
 #![allow(stable_features)]
-#![doc(html_favicon_url = "https://photino.github.io/zino-docs-zh/assets/zino-logo.png")]
-#![doc(html_logo_url = "https://photino.github.io/zino-docs-zh/assets/zino-logo.svg")]
+#![forbid(unsafe_code)]
+
 #![feature(associated_type_defaults)]
 #![feature(async_fn_in_trait)]
 #![feature(decl_macro)]
 #![feature(doc_auto_cfg)]
 #![feature(lazy_cell)]
 #![feature(let_chains)]
 #![feature(slice_first_last_chunk)]
-#![forbid(unsafe_code)]
 
 mod crypto;
 mod encoding;

zino-derive/README.md

@@ -1,3 +1,11 @@
-# zino-derive
+[![github]](https://github.com/photino/zino)
+[![crates-io]](https://crates.io/crates/zino-derive)
+[![docs-rs]](https://docs.rs/zino-derive)
 
-Derived traits for zino.
+[github]: https://img.shields.io/badge/github-8da0cb?labelColor=555555&logo=github
+[crates-io]: https://img.shields.io/badge/crates.io-fc8d62?labelColor=555555&logo=rust
+[docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?labelColor=555555&logo=docs.rs
+
+Derived traits for [`zino`].
+
+[`zino`]: https://github.com/photino/zino

zino-derive/src/lib.rs

@@ -1,20 +1,11 @@
-//! [![github]](https://github.com/photino/zino)
-//! [![crates-io]](https://crates.io/crates/zino-derive)
-//! [![docs-rs]](https://docs.rs/zino-derive)
-//!
-//! [github]: https://img.shields.io/badge/github-8da0cb?labelColor=555555&logo=github
-//! [crates-io]: https://img.shields.io/badge/crates.io-fc8d62?labelColor=555555&logo=rust
-//! [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?labelColor=555555&logo=docs.rs
-//!
-//! Derived traits for [`zino`].
-//!
-//! [`zino`]: https://github.com/photino/zino
-
+#![doc = include_str!("../README.md")]
 #![doc(html_favicon_url = "https://photino.github.io/zino-docs-zh/assets/zino-logo.png")]
 #![doc(html_logo_url = "https://photino.github.io/zino-docs-zh/assets/zino-logo.svg")]
-#![feature(let_chains)]
+
 #![forbid(unsafe_code)]
 
+#![feature(let_chains)]
+
 use convert_case::{Case, Casing};
 use proc_macro::TokenStream;
 use quote::{format_ident, quote};

zino-dioxus/README.md

@@ -1,3 +1,11 @@
-# zino-dioxus
+[![github]](https://github.com/photino/zino)
+[![crates-io]](https://crates.io/crates/zino-dioxus)
+[![docs-rs]](https://docs.rs/zino-dioxus)
 
-Dioxus components for zino.
+[github]: https://img.shields.io/badge/github-8da0cb?labelColor=555555&logo=github
+[crates-io]: https://img.shields.io/badge/crates.io-fc8d62?labelColor=555555&logo=rust
+[docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?labelColor=555555&logo=docs.rs
+
+Dioxus components for [`zino`].
+
+[`zino`]: https://github.com/photino/zino

zino-dioxus/src/lib.rs

@@ -1,3 +1,5 @@
-//! Dioxus components for [`zino`].
-//!
-//! [`zino`]: https://github.com/photino/zino
+#![doc = include_str!("../README.md")]
+#![doc(html_favicon_url = "https://photino.github.io/zino-docs-zh/assets/zino-logo.png")]
+#![doc(html_logo_url = "https://photino.github.io/zino-docs-zh/assets/zino-logo.svg")]
+
+#![forbid(unsafe_code)]

zino-extra/README.md

@@ -1,3 +1,11 @@
-# zino-extra
+[![github]](https://github.com/photino/zino)
+[![crates-io]](https://crates.io/crates/zino-extra)
+[![docs-rs]](https://docs.rs/zino-extra)
 
-Extra utilities for zino.
+[github]: https://img.shields.io/badge/github-8da0cb?labelColor=555555&logo=github
+[crates-io]: https://img.shields.io/badge/crates.io-fc8d62?labelColor=555555&logo=rust
+[docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?labelColor=555555&logo=docs.rs
+
+Extra utilities for [`zino`].
+
+[`zino`]: https://github.com/photino/zino

zino-extra/src/lib.rs

@@ -1,3 +1,5 @@
-//! Extra utilities for [`zino`].
-//!
-//! [`zino`]: https://github.com/photino/zino
+#![doc = include_str!("../README.md")]
+#![doc(html_favicon_url = "https://photino.github.io/zino-docs-zh/assets/zino-logo.png")]
+#![doc(html_logo_url = "https://photino.github.io/zino-docs-zh/assets/zino-logo.svg")]
+
+#![forbid(unsafe_code)]

zino-model/README.md

@@ -1,3 +1,12 @@
-# zino-model
+[![github]](https://github.com/photino/zino)
+[![crates-io]](https://crates.io/crates/zino-model)
+[![docs-rs]](https://docs.rs/zino-model)
+
+[github]: https://img.shields.io/badge/github-8da0cb?labelColor=555555&logo=github
+[crates-io]: https://img.shields.io/badge/crates.io-fc8d62?labelColor=555555&logo=rust
+[docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?labelColor=555555&logo=docs.rs
+
+Domain models for [`zino`].
+
+[`zino`]: https://github.com/photino/zino
 
-Model types for zino.