Skip to content

Cut the documentation to four guides and move provider rationale into code - #552

Merged
zackbart merged 1 commit into
mainfrom
docs/slim-documentation
Sep 17, 2026
Merged

zackbart merged 1 commit into
mainfrom
docs/slim-documentation

Conversation

@zackbart

Copy link
Copy Markdown
Owner

Removes the documentation that had become dead weight and makes the code carry what the deleted guides used to explain.

Removed

  • records/ and eval/, with the load:admission script, the CI benchmark-self-test job, and the .gitignore block that served them.
  • templates/node/AGENTS.md, its CLAUDE.md symlink, and examples/worker/AGENTS.md. connecta init no longer writes them, and scripts/check-package.mjs and test/deployment-shapes.test.ts no longer expect them.
  • Seventeen guides: operations, upgrading, optional-modules-upgrade, connectors, connector-guides, provider-conventions, the seven provider guides, request-admission, operator-ui, storage-and-credentials, call-admission. test/upgrade-guide.test.ts goes with its guide.

documentation/ is now architecture.md, meta-tools.md, code-mode.md, and auth.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 of test/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, and purge_cache's one-variant rule is this connection's contract rather than a Cloudflare API restriction.

The four guides, audited against source

  • auth.md: no longer denies per-tool-set endpoints above the Pools section; the pools example configures auth (as written it admitted nobody); the static-credential handoff needs only visibility; an explicit principal is accepted without activityActorNamespace; Access service-token attribution is service_token_id ?? common_name with the audience as fallback. Gains allowedOrigins and shared versus personal auth, which lost their homes.
  • architecture.md: service counts made true, the request pipeline reordered so pool narrowing precedes the single registry.scoped(), OAuth cancellation split on whether a token response arrived. Gains short sections for admission, storage and credentials, connectors, and the operator UI.
  • meta-tools.md: 503 to 443 lines. States the 50,000-byte default result cap, diagnostics on the call tools, and the search and describe bounds, none of which were written down.
  • code-mode.md: all 70 clause ids unchanged. V1 no longer claims an activity event for an exhausted host-call budget; S1 and S3 match the code; the Verification table cites suites that exist; seven dead links resolved; S1's single 3,500-character line is now readable.

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_tools name from 0.24.2.

npm run release:check passes 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 /credentials page.

🤖 Generated with Claude Code

… 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>
@zackbart
zackbart merged commit 6b3d90b into main Sep 17, 2026
1 check passed
@zackbart
zackbart deleted the docs/slim-documentation branch September 17, 2026 21:52
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