Skip to content

docs: fix stale toolchain and config references - #1011

Open
jiashuoz wants to merge 1 commit into
mainfrom
claude/relaxed-cerf-7u3u84
Open

docs: fix stale toolchain and config references#1011
jiashuoz wants to merge 1 commit into
mainfrom
claude/relaxed-cerf-7u3u84

Conversation

@jiashuoz

@jiashuoz jiashuoz commented Sep 7, 2026

Copy link
Copy Markdown
Member

Summary

Small doc-only audit pass fixing three stale/incomplete references found by cross-checking docs against current code, config, and CI:

  • AGENTS.md — the "Toolchain versions" line still said go.mod declares Go 1.25 and the Dockerfiles build with Go 1.26. go.mod is now go 1.26.0 (CI runs go-version: "1.26"), and Dockerfile/Dockerfile.prober moved to golang:1.27-alpine.
  • CONTRIBUTING.md — the prerequisites table had the same stale Go 1.25 entry.
  • AGENTS.md — the "Send guards & accounting" package list under "Backend architecture" never mentioned internal/sendingpolicy, the sending-protection runtime policy package (the sole provider-authorization gate, ramp/budget composition, operator activation) that several recent PRs built out.
  • docs/deployment.md — the OIDC config table omitted E2A_OIDC_LOGOUT_URL, which config.example.yaml and internal/config already document and internal/auth wires up as the optional post-logout redirect.

No behavior changes — documentation only.

Client surface checklist

Not applicable — this PR is documentation-only and touches no API or client surface.

Operational risk

None — Markdown-only changes.

Test plan

  • Manually verified each claim against current code: go.mod:3, Dockerfile:7, Dockerfile.prober:10, .github/workflows/test.yml go-version entries, internal/sendingpolicy/gate.go, internal/config/config.go:242-245,778-779, internal/auth/auth.go:191-195,553-558, config.example.yaml:86-91.
  • scripts/check-repository-text-integrity.sh — passes (no merge-conflict markers, JSON files untouched).

🤖 Generated with Claude Code

https://claude.ai/code/session_01CR23fVs5zSjJreAZYtpQkb


Generated by Claude Code

AGENTS.md's toolchain line still said Go 1.25 in go.mod and Go 1.26 for
the Dockerfiles; go.mod is now on 1.26.0 and the Dockerfiles moved to
golang:1.27-alpine. CONTRIBUTING.md's prerequisites table had the same
stale Go 1.25.

AGENTS.md's package catalog never mentioned `internal/sendingpolicy`,
the sending-protection runtime policy package (the sole provider-
authorization gate, ramp/budget composition, operator activation) that
several recent PRs built out under "Send guards & accounting".

docs/deployment.md's OIDC config table omitted `E2A_OIDC_LOGOUT_URL`,
which config.example.yaml and internal/config already document and
internal/auth wires up as the optional post-logout redirect.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CR23fVs5zSjJreAZYtpQkb
@jiashuoz jiashuoz self-assigned this Sep 7, 2026
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.

2 participants