alknet/tasks/cleanup/adr-doc-comments.md at eed33967052ba265e2b69cc08bc4f5d7d6289a29

Files

glm-5.1 eed3396705 tasks: add 5 cleanup tasks from Phase 1 review, mark review complete

Review found Phase 1 approved with minor issues. Created cleanup tasks:
- napi-identity-provider-wiring (bug: NAPI bypasses IdentityProvider)
- panic-free-static-config (code smell: panic/unwrap in production path)
- non-exhaustive-public-api (future-proofing public API types)
- adr-doc-comments (doc convention: ADR references in new modules)
- ssh-session-recv-stub-doc (documentation: mark stubs as planned)

2026-06-08 04:35:52 +00:00

1.1 KiB

Raw Blame History

id, name, status, depends_on, scope, risk, impact, level

name

status

depends_on

scope

risk

impact

level

cleanup/adr-doc-comments

Add ADR number references to doc comments in new modules

pending

review/phase1-core-modifications

narrow

trivial

isolated

implementation

Description

The existing codebase has a pattern of referencing ADR numbers in doc comments (e.g., transport/mod.rs references ADR-001). The new Phase 1 modules should follow the same pattern for discoverability.

Modules needing ADR references:

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
interface/mod.rs → ADR-026

Acceptance Criteria

Module-level doc comments reference relevant ADR numbers
Style matches existing ADR references in the codebase (e.g., //! See ADR-029.)

References

crates/alknet-core/src/transport/mod.rs — existing pattern to follow

Notes

Suggested during Phase 1 review (S2)

Summary

To be filled on completion

1.1 KiB Raw Blame History