Skip to content

Commit e7c4e6f

Browse files
committed
Add resources documentation page detailing lifecycle-managed dependencies
- Introduced a new HTML page for the Cano documentation covering the concept of Resources. - Explained the Resource trait, Resources container, key types, lifecycle guarantees, and concurrency. - Provided code examples for implementing resources, retrieving them in tasks, and handling errors. - Included sections on using parameters as resources, workflows without resources, and API reference.
1 parent c4b35c9 commit e7c4e6f

12 files changed

Lines changed: 1876 additions & 1893 deletions

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,13 @@
1111
[![Rust Version](https://img.shields.io/badge/rust-1.89%2B-blue.svg)](https://www.rust-lang.org)
1212

1313
<em>**Orchestrate complex async processes with finite state machines, parallel execution, and built-in scheduling.**</em>
14+
15+
<em>Cano still far from 1.0 release. The API is subject to changes and breaking changes.</em>
16+
1417
</div>
1518

1619
# Overview
20+
1721
Cano is a high-performance orchestration engine designed for building resilient, self-healing systems in Rust. Unlike simple task queues, Cano uses **Finite State Machines (FSM)** to define strict, type-safe transitions between processing steps.
1822

1923
It excels at managing complex lifecycles where state transitions matter:

docs/404.html

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
<meta name="viewport" content="width=device-width, initial-scale=1.0">
66
<title>Page Not Found - Cano Documentation</title>
77
<meta name="description" content="The requested page could not be found in the Cano documentation.">
8+
<meta property="og:title" content="Page Not Found - Cano Documentation">
9+
<meta property="og:description" content="The requested page could not be found in the Cano documentation.">
10+
<meta property="og:type" content="website">
11+
<meta property="og:image" content="logo.png">
12+
<link rel="icon" href="favicon.svg" type="image/svg+xml">
813
<link rel="stylesheet" href="styles.css">
914
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=Outfit:wght@500;700&family=Fira+Code&display=swap" rel="stylesheet">
1015
<script src="script.js" defer></script>
@@ -15,18 +20,27 @@
1520

1621
<nav class="sidebar" role="navigation" aria-label="Main navigation">
1722
<a href="index.html" class="logo">
18-
<img src="logo.png" alt="Cano" style="height: 24px; vertical-align: middle; margin-right: 8px;">
23+
<img src="logo.png" alt="">
1924
Cano
2025
</a>
2126
<ul class="nav-links">
2227
<li><a href="index.html">Home</a></li>
2328
<li><a href="task.html">Tasks</a></li>
2429
<li><a href="nodes.html">Nodes</a></li>
2530
<li><a href="workflows.html">Workflows</a></li>
31+
<li><a href="resources.html">Resources</a></li>
2632
<li><a href="store.html">Store</a></li>
2733
<li><a href="scheduler.html">Scheduler</a></li>
2834
<li><a href="tracing.html">Tracing</a></li>
2935
</ul>
36+
<div class="sidebar-footer">
37+
<span class="version-badge">v0.8.0</span>
38+
<div class="sidebar-links">
39+
<a href="https://github.com/nassor/cano" title="GitHub Repository" aria-label="GitHub">GitHub</a>
40+
<a href="https://crates.io/crates/cano" title="Crates.io" aria-label="Crates.io">Crates.io</a>
41+
<a href="https://docs.rs/cano" title="API Documentation" aria-label="API Docs">Docs.rs</a>
42+
</div>
43+
</div>
3044
</nav>
3145

3246
<main class="main-content">

docs/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,15 @@
2525

2626
<nav class="sidebar" role="navigation" aria-label="Main navigation">
2727
<a href="index.html" class="logo">
28-
<img src="logo.png" alt="" style="height: 24px; vertical-align: middle; margin-right: 8px;">
28+
<img src="logo.png" alt="">
2929
Cano
3030
</a>
3131
<ul class="nav-links">
3232
<li><a href="index.html">Home</a></li>
3333
<li><a href="task.html">Tasks</a></li>
3434
<li><a href="nodes.html">Nodes</a></li>
3535
<li><a href="workflows.html">Workflows</a></li>
36+
<li><a href="resources.html">Resources</a></li>
3637
<li><a href="store.html">Store</a></li>
3738
<li><a href="scheduler.html">Scheduler</a></li>
3839
<li><a href="tracing.html">Tracing</a></li>

0 commit comments

Comments
 (0)