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:
2026-06-08 05:35:08 +00:00
parent 619a6dcc77
commit 64c54b965e
8 changed files with 33 additions and 2 deletions

View File

@@ -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
> 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.