Skip to content

ci(docs): add spec citation hygiene check (WOR-528)#177

Merged
rickcrawford merged 1 commit into
mainfrom
rickcrawford/wor-528-spec-citation-ci-check
May 17, 2026
Merged

ci(docs): add spec citation hygiene check (WOR-528)#177
rickcrawford merged 1 commit into
mainfrom
rickcrawford/wor-528-spec-citation-ci-check

Conversation

@rickcrawford

Copy link
Copy Markdown
Contributor

Summary

  • New `scripts/check-spec-citations.sh` greps the docs/ trees for the four citation regressions flagged in the 2026-05-15 Public RFCs audit. Bans "April 2026 MCP" / "2026-04 MCP" (the actual spec is MCP 2025-11-25) and "Coinbase x402" outside the "Coinbase-hosted reference facilitator" exemption (x402 moved to a Linux Foundation project on 2026-04-02).
  • Wired into the existing `docs-ci` workflow as a fourth step after the lychee link-check and rust-script code-block checks. The sbproxy + sbproxy-enterprise docs trees are clean today, so the addition is a pure guardrail against regression.
  • Source-file `CIMD` identifiers in the auth gateway are intentionally out of scope; the rename rides WOR-518.

Partially closes WOR-528 (CI guardrail piece). The `docs/AIGOVERNANCE.md` x402-line rewrite is still held back behind unrelated docs-tree in-flight work.

Test plan

  • `bash scripts/check-spec-citations.sh` (no banned citations)
  • `ENTERPRISE_ROOT=../sbproxy-enterprise bash scripts/check-spec-citations.sh` (no banned citations)
  • Smoke test against a synthetic "April 2026 MCP" string: exits 1 with the expected error message

`scripts/check-spec-citations.sh` greps the docs trees for the four
spec-citation regressions called out in the 2026-05-15 Public RFCs
audit:

- "April 2026 MCP" / "2026-04 MCP" -> the actual spec revision is
  MCP 2025-11-25.
- "Coinbase x402" outside the "Coinbase-hosted reference
  facilitator" exemption -> x402 moved to a Linux Foundation
  project on 2026-04-02; cite "x402 (Linux Foundation)" instead.

The check is wired into the existing `docs-ci` workflow as a
fourth step after the lychee + rust-script blocks. Source files
under `crates/` are intentionally out of scope: `CIMD` identifiers
in the auth gateway are tracked separately for rename under
WOR-518, and the docs trees today contain no banned strings, so
adding the check is a pure guardrail against regression.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@rickcrawford rickcrawford merged commit 33647e0 into main May 17, 2026
4 of 5 checks passed
@rickcrawford rickcrawford deleted the rickcrawford/wor-528-spec-citation-ci-check branch May 17, 2026 06:35
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.

1 participant