Cut the documentation to four guides and move provider rationale into code - #552
Merged
Merged
Conversation
… code Remove records/, eval/, the template and Worker agent instruction files, and seventeen guides, leaving architecture, meta-tools, code-mode, and auth. Source comments that deferred to the deleted guides now carry the rationale themselves, and the provider conventions H1-H14 and P1-P13 are defined in test/provider-conventions.test.ts. The four surviving guides are audited against source and absorb what the deleted ones owned: allowedOrigins and shared versus personal auth in auth.md, admission, storage, connectors, and the operator UI in architecture.md. connecta init no longer writes AGENTS.md or a CLAUDE.md symlink. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This was referenced Sep 17, 2026
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.
Removes the documentation that had become dead weight and makes the code carry what the deleted guides used to explain.
Removed
records/andeval/, with theload:admissionscript, the CIbenchmark-self-testjob, and the.gitignoreblock that served them.templates/node/AGENTS.md, itsCLAUDE.mdsymlink, andexamples/worker/AGENTS.md.connecta initno longer writes them, andscripts/check-package.mjsandtest/deployment-shapes.test.tsno longer expect them.test/upgrade-guide.test.tsgoes with its guide.documentation/is nowarchitecture.md,meta-tools.md,code-mode.md, andauth.md.Rationale moved into code
About 60 source comments deferred to the deleted guides (
See documentation/cloudflare.md#typed-failures). Each now states its reason inline, keeping vendor provenance: documented rate limits, pinned API versions, the dates tool references were read. Borderline tool classifications in the RevenueCat, Stripe, Linear, and Mixpanel maps carry a one-line reason beside the row. The provider conventions H1–H14 and P1–P13, cited by id across providers and tests, are defined in the header oftest/provider-conventions.test.ts. Comments only; no provider code or model-facing string changed.Two existing comments were wrong and are corrected:
api()makes three construction-time checks, not two, andpurge_cache's one-variant rule is this connection's contract rather than a Cloudflare API restriction.The four guides, audited against source
auth(as written it admitted nobody); the static-credential handoff needs only visibility; an explicitprincipalis accepted withoutactivityActorNamespace; Access service-token attribution isservice_token_id ?? common_namewith the audience as fallback. GainsallowedOriginsand shared versus personal auth, which lost their homes.registry.scoped(), OAuth cancellation split on whether a token response arrived. Gains short sections for admission, storage and credentials, connectors, and the operator UI.diagnosticson the call tools, and the search and describe bounds, none of which were written down.Upgrade guidance is each CHANGELOG release's opening paragraph, and README says so. CHANGELOG gains an Unreleased entry for this change, a narrative paragraph for 0.24.1, and loses the removed
describe_toolsname from 0.24.2.npm run release:checkpasses locally: 119 files, 3267 tests passed, 37 skipped. The Docker container smoke was skipped locally and runs here.Follow-up filed as #551: runtime messages still point at the nonexistent
/credentialspage.🤖 Generated with Claude Code