d_engine/docs/architecture/mod.rs
1//! # Architecture Documentation
2//!
3//! This section covers D-Engine's architecture and design principles. These documents
4//! explain core components, how they interact, and the design decisions behind them.
5//!
6//! ## Topics
7//!
8//! - [Single Responsibility Principle](self::single_responsibility_principle) - Core design philosophy
9//! - [Error Handling Design](self::error_handling_design_principles) - Error management approach
10//! - [Raft Role Implementation](self::raft_role) - Leader, follower and candidate behaviors
11//! - [Snapshot Design](self::snapshot_module_design) - State transfer and recovery
12//! - [Node Joining](self::new_node_join_architecture) - Dynamic cluster membership
13//! - [Election Design](self::election_design) - Leader election process
14//! - [Log Persistence](self::raft_log_persistence_architecture) - Durable storage design
15
16pub mod single_responsibility_principle {
17 #![doc = include_str!("single-responsibility-principle.md")]
18}
19
20pub mod error_handling_design_principles {
21 #![doc = include_str!("error-handling-design-principles.md")]
22}
23
24pub mod raft_role {
25 #![doc = include_str!("raft-role.md")]
26}
27
28pub mod snapshot_module_design {
29 #![doc = include_str!("snapshot-module-design.md")]
30}
31
32pub mod new_node_join_architecture {
33 #![doc = include_str!("new-node-join-architecture.md")]
34}
35
36pub mod election_design {
37 #![doc = include_str!("election-design.md")]
38}
39
40pub mod raft_log_persistence_architecture {
41 #![doc = include_str!("raft-log-persistence-architecture.md")]
42}