diff --git a/crates/alknet-core/src/auth/identity.rs b/crates/alknet-core/src/auth/identity.rs index 4f39997..bd969d6 100644 --- a/crates/alknet-core/src/auth/identity.rs +++ b/crates/alknet-core/src/auth/identity.rs @@ -1,3 +1,8 @@ +//! Identity resolution and the `IdentityProvider` trait. +//! +//! See [ADR-029](docs/architecture/decisions/029-identity-provider.md) and +//! [ADR-028](docs/architecture/decisions/028-identity-model.md). + use std::collections::HashMap; use std::sync::Arc; diff --git a/crates/alknet-core/src/call/mod.rs b/crates/alknet-core/src/call/mod.rs index 09d47ed..2dabb2e 100644 --- a/crates/alknet-core/src/call/mod.rs +++ b/crates/alknet-core/src/call/mod.rs @@ -1,3 +1,8 @@ +//! Call protocol layer (Layer 3) of the three-layer model. +//! +//! See [ADR-024](docs/architecture/decisions/024-call-protocol.md) and +//! [ADR-033](docs/architecture/decisions/033-call-protocol-extensions.md). + pub mod context; pub mod env; pub mod envelope; diff --git a/crates/alknet-core/src/call/spec.rs b/crates/alknet-core/src/call/spec.rs index e1efaa8..e6eb71d 100644 --- a/crates/alknet-core/src/call/spec.rs +++ b/crates/alknet-core/src/call/spec.rs @@ -1,3 +1,8 @@ +//! Operation specifications (type, access control) for the call protocol. +//! +//! See [ADR-025](docs/architecture/decisions/025-operation-spec.md) and +//! [ADR-033](docs/architecture/decisions/033-call-protocol-extensions.md). + use serde::{Deserialize, Serialize}; use serde_json::Value; diff --git a/crates/alknet-core/src/config/config_service.rs b/crates/alknet-core/src/config/config_service.rs index 173eca5..fe55c2b 100644 --- a/crates/alknet-core/src/config/config_service.rs +++ b/crates/alknet-core/src/config/config_service.rs @@ -1,3 +1,7 @@ +//! Configuration service for runtime config reload. +//! +//! See [ADR-030](docs/architecture/decisions/030-dynamic-config.md). + use std::sync::Arc; use arc_swap::ArcSwap; diff --git a/crates/alknet-core/src/config/dynamic_config.rs b/crates/alknet-core/src/config/dynamic_config.rs index ca25160..ca7f588 100644 --- a/crates/alknet-core/src/config/dynamic_config.rs +++ b/crates/alknet-core/src/config/dynamic_config.rs @@ -1,3 +1,7 @@ +//! Runtime-reloadable dynamic configuration (auth policy, forwarding policy, rate limits). +//! +//! See [ADR-030](docs/architecture/decisions/030-dynamic-config.md). + use std::collections::HashMap; use std::sync::Arc; diff --git a/crates/alknet-core/src/config/forwarding.rs b/crates/alknet-core/src/config/forwarding.rs index 927040a..553c0e3 100644 --- a/crates/alknet-core/src/config/forwarding.rs +++ b/crates/alknet-core/src/config/forwarding.rs @@ -1,3 +1,7 @@ +//! Forwarding policy engine for per-identity and per-transport access control. +//! +//! See [ADR-031](docs/architecture/decisions/031-forwarding-policy.md). + use std::net::IpAddr; use std::ops::Range; use std::str::FromStr; diff --git a/crates/alknet-core/src/config/static_config.rs b/crates/alknet-core/src/config/static_config.rs index 55235cf..f8eb54c 100644 --- a/crates/alknet-core/src/config/static_config.rs +++ b/crates/alknet-core/src/config/static_config.rs @@ -1,3 +1,7 @@ +//! Static (immutable) server configuration resolved at startup. +//! +//! See [ADR-030](docs/architecture/decisions/030-dynamic-config.md). + use crate::interface::InterfaceKind; use crate::server::handler::{ProxyConfig, ProxyMode}; use crate::server::serve::{ListenerConfig, ServeTransportMode}; diff --git a/tasks/cleanup/adr-doc-comments.md b/tasks/cleanup/adr-doc-comments.md index c1b6515..ac75bc6 100644 --- a/tasks/cleanup/adr-doc-comments.md +++ b/tasks/cleanup/adr-doc-comments.md @@ -1,7 +1,7 @@ --- id: cleanup/adr-doc-comments name: Add ADR number references to doc comments in new modules -status: pending +status: completed depends_on: - review/phase1-core-modifications scope: narrow @@ -39,4 +39,4 @@ The existing codebase has a pattern of referencing ADR numbers in doc comments ( ## Summary -> To be filled on completion \ No newline at end of file +> Added ADR number references to module-level doc comments in auth/identity.rs (ADR-029, ADR-028), config/forwarding.rs (ADR-031), config/static_config.rs (ADR-030), config/dynamic_config.rs (ADR-030), config/config_service.rs (ADR-030), call/mod.rs (ADR-024, ADR-033), call/spec.rs (ADR-025, ADR-033). Style matches existing pattern in transport/mod.rs. \ No newline at end of file