Skip to content

Commit

Permalink
Update entry docs for the crate
Browse files Browse the repository at this point in the history
  • Loading branch information
popzxc committed Jun 25, 2024
1 parent 577d55d commit 59b38a5
Showing 1 changed file with 1 addition and 9 deletions.
10 changes: 1 addition & 9 deletions core/node/node_framework/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,22 +1,14 @@
//! # ZK Stack node initialization framework.
//!
//! ## Introduction
//!
//! This crate provides core abstractions that allow one to compose a ZK Stack node.
//! Main concepts used in this crate are:
//! - [`WiringLayer`](wiring_layer::WiringLayer) - builder interface for tasks.
//! - [`Task`](task::Task) - a unit of work that can be executed by the node.
//! - [`Resource`](resource::Resource) - a piece of logic that can be shared between tasks. Most resources are
//! represented by generic interfaces and also serve as points of customization for tasks.
//! - [`ResourceProvider`](resource::ResourceProvider) - a trait that allows one to provide resources to the node.
//! - [`ZkStackService`](service::ZkStackService) - a container for tasks and resources that takes care of initialization, running
//! and shutting down.
//!
//! The general flow to compose a node is as follows:
//! - Create a [`ResourceProvider`](resource::ResourceProvider) that can provide all the resources that the node needs.
//! - Create a [`ZkStackService`](node::ZkStackService) with that [`ResourceProvider`](resource::ResourceProvider).
//! - Add tasks to the node.
//! - Run it.
//! - [`ZkStackServiceBuilder`](service::ZkStackServiceBuilder) - a builder for the service.
pub mod implementations;
pub mod resource;
Expand Down

0 comments on commit 59b38a5

Please sign in to comment.