docs: add ADR number references to module doc comments
New Phase 1 modules should follow the existing pattern of referencing ADR numbers in module-level doc comments for discoverability, matching the style in transport/mod.rs.
This commit is contained in:
@@ -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::collections::HashMap;
|
||||||
use std::sync::Arc;
|
use std::sync::Arc;
|
||||||
|
|
||||||
|
|||||||
@@ -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 context;
|
||||||
pub mod env;
|
pub mod env;
|
||||||
pub mod envelope;
|
pub mod envelope;
|
||||||
|
|||||||
@@ -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::{Deserialize, Serialize};
|
||||||
use serde_json::Value;
|
use serde_json::Value;
|
||||||
|
|
||||||
|
|||||||
@@ -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 std::sync::Arc;
|
||||||
|
|
||||||
use arc_swap::ArcSwap;
|
use arc_swap::ArcSwap;
|
||||||
|
|||||||
@@ -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::collections::HashMap;
|
||||||
use std::sync::Arc;
|
use std::sync::Arc;
|
||||||
|
|
||||||
|
|||||||
@@ -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::net::IpAddr;
|
||||||
use std::ops::Range;
|
use std::ops::Range;
|
||||||
use std::str::FromStr;
|
use std::str::FromStr;
|
||||||
|
|||||||
@@ -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::interface::InterfaceKind;
|
||||||
use crate::server::handler::{ProxyConfig, ProxyMode};
|
use crate::server::handler::{ProxyConfig, ProxyMode};
|
||||||
use crate::server::serve::{ListenerConfig, ServeTransportMode};
|
use crate::server::serve::{ListenerConfig, ServeTransportMode};
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
id: cleanup/adr-doc-comments
|
id: cleanup/adr-doc-comments
|
||||||
name: Add ADR number references to doc comments in new modules
|
name: Add ADR number references to doc comments in new modules
|
||||||
status: pending
|
status: completed
|
||||||
depends_on:
|
depends_on:
|
||||||
- review/phase1-core-modifications
|
- review/phase1-core-modifications
|
||||||
scope: narrow
|
scope: narrow
|
||||||
@@ -39,4 +39,4 @@ The existing codebase has a pattern of referencing ADR numbers in doc comments (
|
|||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
> To be filled on completion
|
> 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.
|
||||||
Reference in New Issue
Block a user