Skip to content

docs: add 7 missing backend packages to AGENTS.md's package inventory - #1092

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

jiashuoz wants to merge 1 commit into
mainfrom
claude/relaxed-cerf-apk0vb

Conversation

@jiashuoz

Copy link
Copy Markdown
Member

Summary

Scheduled documentation audit (Markdown-only). Before starting, I checked for prior unmerged doc-audit work per this run's step 0: all prior claude/relaxed-cerf-* doc-audit branches are either already merged into main, or — in the one exception, claude/relaxed-cerf-nzxqy4 (PR #1037, protection-config example schema + internal/delegated AGENTS.md mention) — closed by @jiashuoz pending a redo against the current tree. That item (and the internal/delegated package specifically) is intentionally excluded here to avoid duplicating it.

  • AGENTS.md — the "Key packages, grouped" inventory under "Backend architecture" is cross-checked against every directory in internal/ on every prior audit pass, but had drifted again: 7 real, in-use packages were missing entirely.
    • rfcmessageid — RFC 5322 Message-ID parsing/canonicalization (used by relay, identity for threading). Added to Intake/parsing.
    • filterquery — boolean filter-query language parser/validator (used by httpapi/messages.go, identity for message search). Added to API surface.
    • domainteardown — durable state shared by domain deletion, sender-identity convergence, and the public deletion receipt (used by identity, senderidentity, httpapi/domains.go). Added to Agent identity.
    • suppressionsync — write side of the account suppression list that provider feedback drives. Added to Delivery.
    • webhooknotify — sends webhook endpoint health emails (warning, auto-disable). Added to Webhooks & jobs.
    • sendingaccessnotice — emails the account owner the operator's decision on an external sending-access request. Added to Send guards & accounting.
    • billingnotify — delivers account trash/restore transitions to the external billing service as durable River jobs. Added to Misc/infra.

Each was verified against its package doc comment (// Package ... ) and real call sites before being added — no speculative entries.

No behavior changes — documentation-only.

Test plan

  • Confirmed each of the 7 packages has a real // Package <name> ... doc comment and at least one non-test caller in internal/.
  • Confirmed none of the 7 is already mentioned anywhere else in AGENTS.md.
  • bash scripts/check-repository-text-integrity.sh — passes.
  • Confirmed internal/delegated (the one package deliberately left out) is still only covered by the unmerged claude/relaxed-cerf-nzxqy4 branch, so this PR doesn't duplicate it.

Generated by Claude Code

Cross-checked internal/ against AGENTS.md's "Key packages, grouped"
list — rfcmessageid, domainteardown, suppressionsync, filterquery,
webhooknotify, sendingaccessnotice, and billingnotify are all real,
in-use packages (verified against their call sites and package doc
comments) that were never added to the inventory. internal/delegated
is intentionally left out: it's covered by the still-unmerged
claude/relaxed-cerf-nzxqy4 branch (PR #1037), which the maintainer
closed pending a redo against the current tree.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01QmKrrZvBVcmTWrWdYTujmY
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