git pchore(release): cano + cano-macros 0.10.0

Author: nassor

README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <img src="docs/logo.png" alt="Cano Logo" width="200">
+  <img src="docs/static/logo.png" alt="Cano Logo" width="200">
   <h1>Cano: Type-Safe Async Workflow Engine</h1>
 
 [![Crates.io](https://img.shields.io/crates/v/cano.svg)](https://crates.io/crates/cano)

cano-macros/src/lib.rs

@@ -29,7 +29,7 @@ mod resource_derive;
 mod task_impl;
 
 /// Derive a `from_resources(&Resources<_>) -> CanoResult<Self>` constructor that
-/// pulls each field out of a [`cano::Resources`] map.
+/// pulls each field out of a `cano::Resources` map.
 ///
 /// Each field must be `Arc<T>`. Use `#[res("key")]` for string-literal lookups
 /// or `#[res(EnumType::Variant)]` for enum-path lookups. Use

cano/src/lib.rs

@@ -139,11 +139,11 @@
 //!
 //! ## Module Overview
 //!
-//! - [`task`]: The [`Task`] trait — single `run()` method
-//! - [`node`]: The [`Node`] trait — three-phase lifecycle with retry via [`TaskConfig`]
+//! - [`mod@task`]: The [`Task`] trait — single `run()` method
+//! - [`mod@node`]: The [`Node`] trait — three-phase lifecycle with retry via [`TaskConfig`]
 //! - [`workflow`]: [`Workflow`] — FSM orchestration with Split/Join support
 //! - [`scheduler`] (requires `scheduler` feature): [`Scheduler`] — cron and interval scheduling
-//! - [`resource`]: [`Resource`] trait and [`Resources`] dictionary — lifecycle-aware resource management
+//! - [`mod@resource`]: [`Resource`] trait and [`Resources`] dictionary — lifecycle-aware resource management
 //! - [`store`]: [`MemoryStore`] and the [`KeyValueStore`] trait — [`MemoryStore`] implements [`Resource`]
 //! - [`error`]: [`CanoError`] variants and the [`CanoResult`] alias
 //!
@@ -181,7 +181,7 @@ pub use scheduler::{FlowInfo, Scheduler};
 /// to rewrite `async fn` methods into ones returning
 /// `Pin<Box<dyn Future<Output = ...> + Send + 'async_trait>>`.
 ///
-/// Functionally identical to [`node`] and [`resource`]; the separate name makes
+/// Functionally identical to [`macro@node`] and [`macro@resource`]; the separate name makes
 /// `#[cano::task]` self-documenting at impl sites. The implementation lives in
 /// the [`cano-macros`] sibling crate.
 ///
@@ -190,19 +190,19 @@ pub use cano_macros::task;
 
 /// Attribute macro applied to the `Node` trait definition and `impl Node` blocks.
 ///
-/// See [`task`] for the rewrite shape; this macro is functionally identical and
+/// See [`macro@task`] for the rewrite shape; this macro is functionally identical and
 /// differs only in name.
 pub use cano_macros::node;
 
 /// Attribute macro applied to the `Resource` trait definition and `impl Resource` blocks.
 ///
-/// See [`task`] for the rewrite shape; this macro is functionally identical and
+/// See [`macro@task`] for the rewrite shape; this macro is functionally identical and
 /// differs only in name.
 pub use cano_macros::resource;
 
 /// Derive macro that generates a `from_resources` associated function for a struct.
 ///
-/// See [`cano_macros::derive_from_resources`] for the full specification. Each
+/// See [`FromResources`] for the full specification. Each
 /// field must be `Arc<T>`; annotate it with `#[res("key")]` or
 /// `#[res(EnumKey::Variant)]`.
 pub use cano_macros::FromResources;
@@ -213,9 +213,8 @@ pub use cano_macros::FromResources;
 /// but derived directly from the struct definition. The trait's no-op `setup`
 /// and `teardown` defaults take effect automatically.
 ///
-/// In the prelude, this is exported as [`Resource`](crate::prelude::Resource)
-/// alongside the trait of the same name — Rust's separate macro and type
-/// namespaces let them coexist.
+/// In the prelude, this is exported as [`Resource`] alongside the trait of the
+/// same name — Rust's separate macro and type namespaces let them coexist.
 pub use cano_macros::Resource;
 
 // Convenience re-exports for common patterns

cano/src/node.rs

@@ -5,12 +5,12 @@
 //!
 //! ## Task vs Node - Choose the Right Tool
 //!
-//! - **Use [`Task`]** for simple processing with a single `run()` method.
+//! - **Use [`Task`](crate::task::Task)** for simple processing with a single `run()` method.
 //! - **Use [`Node`]** for structured processing with a three-phase lifecycle.
 //!
 //! Both `Task` and `Node` support retry strategies.
 //!
-//! **Every [`Node`] automatically implements [`Task`]**, so you can mix and match in the same workflow.
+//! **Every [`Node`] automatically implements [`Task`](crate::task::Task)**, so you can mix and match in the same workflow.
 //!
 //! ## Unified API Benefits
 //!
@@ -434,7 +434,7 @@ where
 ///
 /// Use this when you need to store different node types in the same collection.
 /// `TResourceKey` defaults to [`Cow<'static, str>`](std::borrow::Cow) to match
-/// [`Resources`](crate::resource::Resources); pass an enum key type for typed
+/// [`Resources`]; pass an enum key type for typed
 /// resource lookups.
 pub type DynNode<TState, TResourceKey = Cow<'static, str>> = dyn Node<TState, TResourceKey, PrepResult = DefaultNodeResult, ExecResult = DefaultNodeResult>
     + Send

cano/src/scheduler.rs

@@ -9,7 +9,7 @@
 //!
 //! ```toml
 //! [dependencies]
-//! cano = { version = "0.8", features = ["scheduler"] }
+//! cano = { version = "0.10", features = ["scheduler"] }
 //! ```
 
 use crate::error::{CanoError, CanoResult};

cano/src/task.rs

@@ -573,7 +573,7 @@ where
 ///
 /// Use this when you need to store different task types in the same collection.
 /// `TResourceKey` defaults to [`Cow<'static, str>`](std::borrow::Cow) to match
-/// [`Resources`](crate::resource::Resources); pass an enum key type for typed
+/// [`Resources`]; pass an enum key type for typed
 /// resource lookups.
 ///
 /// ```

cano/src/workflow.rs

@@ -304,7 +304,7 @@ where
 {
     /// State machine with support for split/join.
     /// Arc-wrapped so the FSM loop clones the entry as a cheap refcount bump
-    /// rather than cloning the inner Vec<Arc<dyn Task>> on every iteration.
+    /// rather than cloning the inner `Vec<Arc<dyn Task>>` on every iteration.
     states: HashMap<TState, Arc<StateEntry<TState, TResourceKey>>>,
     /// Shared resources for all tasks
     pub(crate) resources: Arc<Resources<TResourceKey>>,

docs/config.toml

@@ -7,7 +7,7 @@ build_search_index = false
 generate_feeds = false
 
 [extra]
-version = "0.9.0"
+version = "0.10.0"
 github_url = "https://github.com/nassor/cano"
 crates_url = "https://crates.io/crates/cano"
 docsrs_url = "https://docs.rs/cano"

docs/content/_index.md

@@ -79,10 +79,12 @@ It excels at managing complex lifecycles where state transitions matter:
 
 <div class="getting-started-code">
 <pre><code class="language-toml">[dependencies]
-cano = { version = "0.8", features = ["all"] }
-tokio = { version = "1", features = ["full"] }</code></pre>
+cano = { version = "0.10", features = ["all"] }
+tokio = { version = "1", features = ["macros", "rt-multi-thread"] }</code></pre>
 </div>
 
+<p>Cano runs on the Tokio runtime, so <code>tokio</code> is a required direct dependency — you launch the runtime via <code>#[tokio::main]</code> or <code>tokio::runtime::Builder</code>. The two features above are the minimum to do that; add <code>"time"</code>, <code>"sync"</code>, etc. only if your own code calls into them. Use <code>"full"</code> if you prefer convenience over compile time.</p>
+
 <h3>Basic Example</h3>
 <div class="getting-started-code">
 <pre><code class="language-rust">use cano::prelude::*;

docs/content/tracing.md

@@ -44,12 +44,12 @@ All tracing instrumentation is behind conditional compilation, so it adds zero o
 <code>features = ["all"]</code> to enable both <code>tracing</code> and <code>scheduler</code> at once.</p>
 
 <pre><code class="language-toml">[dependencies]
-cano = { version = "0.8", features = ["tracing"] }
+cano = { version = "0.10", features = ["tracing"] }
 tracing = "0.1"
 tracing-subscriber = { version = "0.3", features = ["env-filter"] }
 <!--blank-->
 # Or enable everything (tracing + scheduler):
-# cano = { version = "0.8", features = ["all"] }</code></pre>
+# cano = { version = "0.10", features = ["all"] }</code></pre>
 
 <h3 id="basic-init"><a href="#basic-init" class="anchor-link" aria-hidden="true">#</a>Basic Initialization</h3>
 <p>For quick setup during development, use the default formatter.</p>
@@ -161,7 +161,7 @@ execution in log output.</p>
 
 <pre><code class="language-toml"># Enable both scheduler and tracing
 [dependencies]
-cano = { version = "0.8", features = ["all"] }</code></pre>
+cano = { version = "0.10", features = ["all"] }</code></pre>
 <hr class="section-divider">
 
 <h2 id="custom-spans"><a href="#custom-spans" class="anchor-link" aria-hidden="true">#</a>Custom Spans</h2>