docs(code): add module-level doc blocks to providers, channels, tools, and security
Each major subsystem mod.rs now includes a //! doc block explaining the subsystem purpose, trait-driven architecture, factory registration pattern, and extension guidance. This improves the generated rustdoc experience for developers navigating ZeroClaw's modular architecture. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
parent
bec1dc7b8c
commit
4a7dff6ef1
4 changed files with 71 additions and 0 deletions
|
|
@ -1,3 +1,19 @@
|
|||
//! Channel subsystem for messaging platform integrations.
|
||||
//!
|
||||
//! This module provides the multi-channel messaging infrastructure that connects
|
||||
//! ZeroClaw to external platforms. Each channel implements the [`Channel`] trait
|
||||
//! defined in [`traits`], which provides a uniform interface for sending messages,
|
||||
//! listening for incoming messages, health checking, and typing indicators.
|
||||
//!
|
||||
//! Channels are instantiated by [`start_channels`] based on the runtime configuration.
|
||||
//! The subsystem manages per-sender conversation history, concurrent message processing
|
||||
//! with configurable parallelism, and exponential-backoff reconnection for resilience.
|
||||
//!
|
||||
//! # Extension
|
||||
//!
|
||||
//! To add a new channel, implement [`Channel`] in a new submodule and wire it into
|
||||
//! [`start_channels`]. See `AGENTS.md` §7.2 for the full change playbook.
|
||||
|
||||
pub mod cli;
|
||||
pub mod dingtalk;
|
||||
pub mod discord;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue