docs: fine tune docs

appenders/async/src/worker.rs

@@ -43,8 +43,11 @@ impl Worker {
                     record,
                     diags,
                 } => {
-                    let diags: Vec<Box<dyn Diagnostic>> = vec![Box::new(OwnedDiagnostic(diags))];
-                    let diags = diags.as_slice();
+                    let diags: &[Box<dyn Diagnostic>] = if diags.is_empty() {
+                        &[]
+                    } else {
+                        &[Box::new(OwnedDiagnostic(diags))]
+                    };
                     let record = record.as_record();
                     for append in appends.iter() {
                         if let Err(err) = append.append(&record, diags) {

core/src/diagnostic/mod.rs

@@ -14,7 +14,7 @@
 
 //! Mapped Diagnostic Context (MDC).
 //!
-//! A lighter technique consists of uniquely stamping each log request.
+//! A light-weight technique for stamping log request.
 
 use std::fmt;
 

core/src/diagnostic/static_global.rs

@@ -28,7 +28,7 @@ use crate::kv::Visitor;
 /// use logforth_core::diagnostic::StaticDiagnostic;
 ///
 /// let mut diagnostic = StaticDiagnostic::default();
-/// diagnostic.insert("key", "value");
+/// diagnostic.insert("app_name", "acme");
 /// ```
 #[derive(Default, Debug, Clone)]
 #[non_exhaustive]

logforth/src/lib.rs

@@ -30,10 +30,10 @@
 //!
 //! # Examples
 //!
-//! Simple setup with default stdout appender:
+//! Simple setup with a stderr appender:
 //!
 //! ```
-//! logforth::starter_log::stdout().apply();
+//! logforth::starter_log::stderr().apply();
 //!
 //! log::info!("This is an info message.");
 //! ```
@@ -59,6 +59,10 @@
 //! log::error!("Error message.");
 //! log::info!("Info message.");
 //! ```
+//!
+//! See the [README] file for more details and examples.
+//!
+//! [README]: https://github.com/fast/logforth?tab=readme-ov-file
 
 #![cfg_attr(docsrs, feature(doc_cfg))]
 
@@ -99,7 +103,7 @@ pub mod append {
 pub mod bridge {
     /// Bridge logforth with [`log`].
     ///
-    /// [`log`]: https://docs.rs/log/
+    /// [`log`]: https://docs.rs/log
     #[cfg(feature = "bridge-log")]
     pub mod log {
         #[cfg(feature = "bridge-log")]