Skip to content

docs: rewrite README to house standard - #25

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

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

Conversation

@steipete

@steipete steipete commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Reframes the README as an 82-line front door: dynamic badges, real install and 60-second quick start, a sanitized packaged-app screenshot, progressive capability detail, development, and license.
  • Moves the exhaustive CLI surface to docs/cli.md and local/official packaging details to docs/development.md.

Moved or dropped

  • Preserved the crawler ID/executable mapping, CLI commands, config paths, signing model, and release-artifact details in the new docs.
  • Dropped the photoscrawl “coming soon” label from README prose because it is changelog-style and not a current availability guarantee. The manifest remains documented as a built-in integration.
  • Skipped a changelog entry because this changelog has no precedent for documentation-only entries.

Verification

  • swift build — passed.
  • swift run crawlbar-selftest — passed.
  • swift run crawlbarctl apps --json, metadata --json, and config validate — passed against 12 built-in manifests.
  • Scripts/package_app.sh, packaged helper --help / config validate, and codesign --verify --deep --strict --verbose=2 dist/CrawlBar.app — passed.
  • Installed openclaw/tap/crawlbar, ran every README quick-start command exactly, then removed the test installation and cache — passed.
  • Live/credentialed or mutating CLI examples (status, query, action) were validated against the packaged helper's real --help instead of being executed.
  • All relative links resolve. Every external page and badge returned HTTP 200; badge SVGs contain no invalid or not found card.
  • The screenshot was captured from the packaged app, changed only to replace the user-specific home path with ~/.crawlbar/config.json, cropped, and verified at 1120×690 / 162 KB.
  • Autoreview: /Users/steipete/Projects/agent-skills/skills/autoreview/scripts/autoreview --mode local ... returned clean with no accepted/actionable findings for the complete text bundle. The helper refuses binary diffs by design, so the PNG received the manual privacy/size inspection above.

@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 04f0cc4 into main Aug 3, 2026
3 checks passed
@steipete
steipete deleted the docs/readme-standard branch August 3, 2026 02:20
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