Skip to content

docs: add a real-run demo, concise bilingual READMEs, and a brand kit - #386

Open
reacher-z wants to merge 4 commits into
mainfrom
codex/svg-logo
Open

reacher-z wants to merge 4 commits into
mainfrom
codex/svg-logo

Conversation

@reacher-z

@reacher-z reacher-z commented Oct 11, 2026 •

Copy link
Copy Markdown
Collaborator

What does this PR do?

The README's long setup instructions, historical tables, FAQ, and community material make it hard to see what a ClawBench run produces. Give both languages a short landing page built around the benchmark's purpose, an actual recorded task, scoring evidence, and a minimal install/run path. Move the detailed material into paired English/Chinese guides with working links and preserved historical table values.

Add a 15.5-second demo from the published Claude Opus 4.7 / Hermes Khan Academy trace: choose an answer, capture the attemptProblem request, and show the saved judge's match: true. The GIF is about 167 KiB, with a pauseable MP4 and a reduced-motion poster. Its companion pages link the original recording, actions, interception, and judge files at a pinned dataset revision, record SHA-256 hashes, and explain every crop, speed change, and evidence annotation. The builder checks those hashes and displayed fields before rendering.

Add an original SVG identity with light/dark and monochrome/reversed variants, a small favicon in SVG/PNG/ICO, and a 1200 × 630 social card. Include editable sources, generators, font attribution, usage guidance, and CI checks for generated workflow/brand assets and stale raster exports. Update the changelog.

Preview

Recorded task

English README · 中文 README · Demo evidence · Brand kit

Corpus

  • v2
  • v1
  • both
  • not applicable — documentation and presentation assets; task definitions and runtime scoring are unchanged.

Test plan

  • Verified the four demo source hashes and the request/verdict fields against the pinned published trace; reviewed the browser excerpt and all evidence panels.
  • Decoded the GIF/MP4, checked duration and dimensions, and verified the ICO's 16/32/48/64 px representations and 1200 × 630 social export.
  • Rendered GitHub Markdown output at desktop and mobile widths in both languages and themes; checked reduced-motion fallback, workflow switching, horizontal overflow, and Quickstart navigation.
  • python3 scripts/ci/check_markdown_links.py — 281 local links resolve; separate fragment audit passes.
  • Historical result table rows match the previous README exactly.
  • Both asset generators pass --check; new Python helpers pass Ruff check and format check.
  • git diff --check.

Related issues

N/A

@reacher-z reacher-z changed the title docs: add ClawBench SVG logo and simplify README headers docs: refresh ClawBench branding and bilingual READMEs Oct 11, 2026
@reacher-z reacher-z changed the title docs: refresh ClawBench branding and bilingual READMEs docs: add a real-run demo, concise bilingual READMEs, and a brand kit Oct 12, 2026
@reacher-z

Copy link
Copy Markdown
Collaborator Author

@Perry2004 Please review this PR.

@Perry2004 Perry2004 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please resolve the merge conflict with main.

This branch has not been deployed

No deployments
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.

2 participants