docs: fix stale/inaccurate documentation from a repo-wide audit - #937
Merged
Conversation
- cli/README.md, cli/CHANGELOG.md, cli/src/commands/send.ts — a scheduled send caught by a review hold survives it (send_at is preserved and re-armed on approval), not dropped as these docs claimed. The SDK READMEs and server already documented this correctly; only the CLI docs/comment had it backwards. - docs/api.md — beta operation count was stale at 29; the delivery-metrics endpoints (getAgentMetrics/getAccountMetrics) brought it to 31 without updating the summary line above the table. - README.md — the beta-surface enumeration in the GA banner omitted delivery metrics, which is beta per the same table/spec. Also softened the self-host "every feature works the same" claim, which contradicted the Content screening section's note that screening isn't yet enabled on the hosted service. - docs/runbooks/mcp-server.md — MCP_ALLOWED_HOSTS no longer has a literal default of api.e2a.dev; that fallback was removed so a misconfigured self-host fails closed instead of silently trusting the operator's host. - plugins/e2a/skills/e2a-integrate/references/rest-openapi.md — pointed the canonical OpenAPI contract link at api.e2a.dev; every other reference in the repo (and the doc's own stated host split) uses e2a.dev for documentation/spec links. Checked for prior unmerged doc-audit work first: no open PR touches documentation, and the six earlier claude/relaxed-cerf-* audit branches were all already merged (their PRs report merged:false via the list API, but pull_request_read confirms merged:true and their content is already present on main) — nothing here duplicates them. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NrStwEiQDm7z4B9Lekj1kD
AmirF194
reviewed
Aug 27, 2026
AmirF194
left a comment
Contributor
There was a problem hiding this comment.
I ran this against c02bfca in a clean container.
CI's "Package and manifests" job is red on this PR (run 32751177659), and it is caused by this diff. scripts/check-plugin-version-bump.mjs requires a version bump in plugins/<name>/.claude-plugin/plugin.json whenever any file under plugins/<name>/ changes. This PR edits plugins/e2a/skills/e2a-integrate/references/rest-openapi.md but leaves plugins/e2a/.claude-plugin/plugin.json at 0.9.1.
$ node scripts/check-plugin-version-bump.mjs e1f8b1839b3817029bfc3b43f606f91582ff69f4
Changed plugins must bump their versions:
- e2a remains at 0.9.1
EXIT:1
Bumping plugins/e2a/.claude-plugin/plugin.json's version to 0.9.2 clears it:
$ node scripts/check-plugin-version-bump.mjs e1f8b1839b3817029bfc3b43f606f91582ff69f4
Plugin version bumps are current: e2a
EXIT:0
Member
Author
|
Thanks @AmirF194! Bumped the plugin to 0.9.2 and regenerated the manifests — the version-bump gate is now green. Appreciate the catch. |
Contributor
|
Confirmed, thanks for the quick turnaround. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Scheduled documentation audit across all
.mdfiles in the repo (READMEs,docs/, examples, plugin/skill docs), cross-checked against current code.docs/design/**anddocs/superpowers/**(dated design docs/plans) were intentionally excluded — staleness there is expected and out of scope.Before starting, I checked for prior unmerged doc-audit work: no currently open PR touches documentation. Six earlier
claude/relaxed-cerf-*doc-audit branches still exist on the remote, butpull_request_readon each of their PRs (#716, #666, #731, #763, #812, #905) confirmsmerged: trueand their content is already present onmain— nothing in this PR duplicates them. (Note: the list-PRs API'smergedfield reportedfalsefor all of these, which is misleading —pull_request_read/the PR page is the reliable source.)Changes by file
cli/README.md,cli/CHANGELOG.md,cli/src/commands/send.ts— all three said a review hold caused a scheduled self-send to drop its--send-atschedule entirely. That's backwards:internal/agent/schedule_hold_test.go'sTestDeliverOutbound_HoldPreservesScheduledAt(feat(api): preserve send_at across a review hold instead of discarding it #815) and the server's own field docs (internal/httpapi/reviews.go,internal/httpapi/outbound.go) confirm a schedule caught by a hold survives it — the held message keeps itssend_at, and approving it submits at that instant if still future, or immediately if it's passed. The TS/Python SDK READMEs already documented this correctly; only the CLI docs and a matching source comment had it backwards.docs/api.md— the beta-operation-count summary line said "29 beta operations," but the table right below it lists 31 (thegetAgentMetrics/getAccountMetricsdelivery-metrics endpoints were added to the table without updating the count above it). Fixed to 31.README.md— the GA banner's explicit beta-surface list omitted delivery metrics, which is markedx-stability-level: betain the spec and listed as beta indocs/api.md's own table. Added it. Also softened the self-host "every feature works the same" claim, which directly contradicted the Content screening section's note a few paragraphs later that screening isn't yet enabled on the hosted service.docs/runbooks/mcp-server.md— saidMCP_ALLOWED_HOSTSdefaults toapi.e2a.dev. That literal default was removed in fix: stop defaulting to the operator's infrastructure #918 ("stop defaulting to the operator's infrastructure");mcp/src/bin/http.tsnow derives the allowlist fromMCP_PUBLIC_URL's host if set, or refuses to start.mcp/README.mdwas already updated for this; this runbook line wasn't.plugins/e2a/skills/e2a-integrate/references/rest-openapi.md— pointed the canonical OpenAPI contract link atapi.e2a.dev. Every other reference to this doc in the repo (plugins/e2a/docs/{auth,setup,sdk,templates}.md,llms.txt, and theirweb/public/mirrors) usese2a.dev, matching the doc set's own stated host split ("Documentation … lives one2a.dev. The REST API and MCP server live onapi.e2a.dev.").Everything else audited (root docs,
docs/, CLI/SDK docs, MCP + example docs, web/plugin docs, tool counts, mirrored-doc sync) checked out against current code — no other high-confidence issues found. One additional stale item was found but deliberately excluded as out of scope for a docs-only PR: the rootVERSIONfile still reads1.0.0against the currentv1.7.12release-tag line, and is read as a build-tag fallback by.github/workflows/publish-mcp-http.yml— bumping it has functional CI-tagging impact and no clear "correct" target value, so it's left for a maintainer decision rather than guessed at here.Docs/comment-only change (the
send.tsedit is a docstring only, no behavior change), so the client-surface checklist doesn't apply.Test plan
bash scripts/check-repository-text-integrity.sh— passesapi/openapi.yaml'sx-stability-levelmarkers for the beta count,mcp/src/bin/http.tsfor the allowlist default, and the doc set's other OpenAPI links for the host convention)🤖 Generated with Claude Code
Generated by Claude Code