Documentation corrections (GTB parity audit, Phase 2)¶
Status: APPROVED — records two factual doc/code-comment corrections the Phase-2 audit (§B and §C2) surfaced. No design decisions; these are accuracy fixes applied during implementation, not features. Captured as a spec so the changes are tracked and reviewable rather than slipped in.
Correction 1 — soften the why-rtb.md "serve subcommand" claim¶
docs/about/why-rtb.md:44 states RTB integrates axum "so your tool can
expose a serve subcommand." No such crate or subcommand exists. That
single line is what makes GTB's pkg/authn, pkg/http (server),
pkg/grpc, pkg/gateway, pkg/openapi read as drift rather than the
deliberate, deferred non-goals the audit classified them as (§C2 of
gtb-parity-audit.md).
Change: reword to make the server/serve story an explicit
deferred-pending-parity item — "RTB may integrate axum for a future
serve subcommand; this is not yet built and is a deliberate deferral
(see the parity audit §C2)." Removes the false implication that a server
surface ships today, while preserving the door the audit chose to keep
open.
Correction 2 — reconcile the CLAUDE.md HTTP-middleware claim¶
CLAUDE.md:244 (§Credential Redaction) states "rtb-cli's HTTP middleware
uses redact::SENSITIVE_HEADERS to redact headers at DEBUG." No such
middleware exists — SENSITIVE_HEADERS is defined in rtb-redact
(lib.rs:26) but is not wired into any reqwest client; rtb-cli has
no http module, and rtb-ai/rtb-telemetry/rtb-vcs each hand-roll
their own client.
Change (one of, decided when the shared-middleware spec is scheduled):
either (a) correct the claim to describe reality (the constant is
available for redaction; no shared middleware is wired yet), or (b) keep
the claim and let it be satisfied by the future shared HTTP client
middleware spec (Phase-2 backlog) that actually wires
SENSITIVE_HEADERS. Until that spec lands, the doc must not assert a
wired middleware that isn't there. Default: (a) now, upgrade to (b)
when the middleware ships.
Scope¶
Documentation/comment edits only — no code behaviour change. Apply at implementation time alongside (Correction 2b) the shared-HTTP-middleware work if/when that is scheduled.
Out of scope¶
- Building the
servesubcommand (deferred — audit §C2). - Building the shared HTTP client middleware (separate Phase-2 backlog item; Correction 2 only stops the doc over-claiming until then).