Skip to content

docs(compliance): name the verifiability gap and the SDK bridge's role (#4593)#4619

Merged
bokelley merged 2 commits into
mainfrom
bokelley/rewrite-issue-4593-framing
May 16, 2026
Merged

docs(compliance): name the verifiability gap and the SDK bridge's role (#4593)#4619
bokelley merged 2 commits into
mainfrom
bokelley/rewrite-issue-4593-framing

Conversation

@bokelley
Copy link
Copy Markdown
Contributor

@bokelley bokelley commented May 16, 2026

Summary

Closes #4593. Documents the test-surface pattern, the SDK's TestControllerBridge, the non-normative _bridge response marker, and the three runtime signals adopters routinely conflate (test controller availability, account.sandbox, _bridge).

Where the content lives

The canonical home is the Conformance Specification — that's the audience that needs this framing (DSP/SSP engineers, RMN proxy implementers, procurement leads reading badge docs). The L3 controller page keeps a short pointer; the AAO Verified page cross-links into it from the existing controller-relationship Note.

File Change
docs/building/verification/conformance.mdx + canonical section — "Test surfaces and the storyboard loop" with the where-state-lives table, _bridge marker description, leading-underscore convention pin, and the three-signal disambiguation table.
docs/building/by-layer/L3/comply-test-controller.mdx Pointer-only — short summary of state-local vs upstream-proxy paths, link to the conformance.mdx section.
docs/building/verification/aao-verified.mdx Reciprocal hook — one sentence in the existing controller-relationship <Note> pointing into the conformance.mdx section.
.changeset/4593-test-surfaces-verifiability-gap.md Updated to match the new shape.

Framing decisions (expert review fed back in)

Test plan

  • npm run check:owned-links — passes
  • npm run test:docs-nav — 15/15 pass
  • pre-commit hook (unit + dynamic-imports + callapi-state-change + typecheck) — passes
  • Visual review of the rendered section in a docs preview build

🤖 Generated with Claude Code

#4593)

Adds a "Test surfaces and the verifiability gap" section to the
comply_test_controller doc, framing the gap as universal across seller
classes. State-local sellers close it via DB-backed `seed_*`; upstream-proxy
sellers close it via the SDK's `TestControllerBridge`. The bridge is one
implementation of the test-surface pattern, not a separate seller category.

Documents the non-normative `_bridge` marker (shipped in adcp-client#1786)
as the response-level signal runners read to distinguish fixture-merged
content from upstream-derived content, and adds a three-axis table covering
test mode, the `account.sandbox` flag, and bridge participation.

Closes #4593.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…expert feedback

Restructures PR #4619 in response to convergent DX/docs/product/protocol-expert
review:

- Canonical home for the framing is `conformance.mdx`, not the L3 controller
  page. The audience for this framing (DSP/SSP engineers, RMN proxy
  implementers, procurement leads reading badge docs) is broader than the
  audience for the controller tool definition.
- Drops the "live behavior" wording to avoid re-importing the deprecated
  (Live) framing rejected in #4379 — (Sandbox) attests sandbox-flag tolerance
  on prod, not adapter-to-upstream calls.
- "Three orthogonal axes" → "Three signals — don't conflate them" so the
  table doesn't collide with the (Spec)/(Sandbox) "two axes" language already
  load-bearing in `conformance.mdx` and `aao-verified.mdx`.
- "Test mode" axis label → "Test controller availability" to disambiguate
  from BidRequest-style test flags an OpenRTB reviewer would expect.
- Defines "state-local sellers" and "upstream-proxy sellers" inline on first
  use (SSPs/creative-agents; DSPs/retail-media/signals-brokers).
- Pins the leading-underscore convention for SDK/runner-stamped metadata
  reserved for testing tooling, so future SDK fields can't pollute the wire
  surface without going through the same gate.
- Leaves a short pointer on the L3 controller page back to the canonical
  section, and adds a reciprocal hook in `aao-verified.mdx`'s existing
  controller-relationship Note.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@bokelley bokelley merged commit 8ee12ab into main May 16, 2026
18 checks passed
@bokelley bokelley deleted the bokelley/rewrite-issue-4593-framing branch May 16, 2026 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Compliance docs: name the verifiability gap and the role of test surfaces

1 participant