Skip to content

docs: rewrite README to house standard - #108

Merged
steipete merged 1 commit into
mainfrom
docs/readme-standard
Aug 3, 2026
Merged

docs: rewrite README to house standard#108
steipete merged 1 commit into
mainfrom
docs/readme-standard

Conversation

@steipete

@steipete steipete commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Rewrites the README as a concise front door: dynamic badges, a plain project description, source installation, one-command local proof, progressive routing/provider/policy sections, deployment links, development, and license.

The exhaustive route inventory, authentication boundaries, compatibility aliases, and routing/accounting semantics move to docs/api-reference.md. Existing deep guides remain canonical for Cloudflare deployment, self-hosting, OpenClaw setup, architecture, retention, Fusion, Bedrock, and agent spend control.

Removed or consolidated

  • Removes the aspirational “current implementation target” framing and the open-ended “future service providers” wording.
  • Consolidates duplicated Cloudflare Access, provider, migration, and accounting prose into the existing focused docs linked from the README.
  • Drops no verified capability. The new API reference also adds implemented session, retained-content, Fusion preview, and grant quota-refresh routes that the old README omitted.

Verification

  • pnpm install --frozen-lockfile — passed with Node 24.18.0 and pnpm 11.5.1.
  • pnpm provider:compile — passed for all 21 manifests.
  • pnpm worker:e2e — passed; local Worker and fixture-upstream smoke completed.
  • pnpm build — passed, including the admin production build and 117 Worker tests.
  • pnpm check — passed: 117 Worker, 26 admin, and 74 script tests.
  • README/API-reference relative-link resolution — passed.
  • All external README targets and four badge URLs — HTTP 200; badge SVGs contain no invalid/not-found card.
  • Distribution checks — no npm package or Homebrew formula/cask; GitHub release v0.1.0 exists.
  • Autoreview — clean, no accepted/actionable findings.

The moved Tavily curl example requires a configured deployment, proxy credential, and live upstream, so it was not sent; its -H and --data flags were validated against curl --help all. Docker is not installed on this host, so the existing self-host commands were not rerun locally; the repository CI builds and smokes that image.

@clawsweeper

clawsweeper Bot commented Aug 3, 2026

Copy link
Copy Markdown

ClawSweeper status: review started.

I am starting a fresh review of this pull request: docs: rewrite README to house standard This is item 1/1 in the current shard. Shard 0/1.

This placeholder means the worker is alive and reading the current context. I will edit this same comment with the actual review when the claws are done clicking.

Crustacean status: shell secured, claws on keyboard, evidence pebbles being sorted.

@steipete
steipete merged commit f82765a into main Aug 3, 2026
5 checks passed
@steipete
steipete deleted the docs/readme-standard branch August 3, 2026 02:01
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