Skip to content

docs: restyle the README header and move reference sections to docs - #481

Merged
reacher-z merged 7 commits into
mainfrom
docs/readme-restyle
Nov 5, 2026
Merged

reacher-z merged 7 commits into
mainfrom
docs/readme-restyle

Conversation

@reacher-z

@reacher-z reacher-z commented Nov 4, 2026 •

Copy link
Copy Markdown
Collaborator

A restrained pass over the README: the header now matches WebsiteBench, and reference material moves into docs/ so the README stays focused on what ClawBench is, how to run it, and the current results. Every moved section leaves a sentence in the README that names its new page.

Rendered branch: https://github.com/TIGER-AI-Lab/ClawBench/blob/docs/readme-restyle/README.md

Changes in the README

Before After
Gradient hero banner (assets/hero-*.svg) Typeset wordmark and tagline in EB Garamond, with light and dark variants
9 shields.io badges in mixed colours, 2 more below, 37 "Featured" badges folded underneath Four badges in the palette: Project Page, Paper, Leaderboard, Dataset; one line points to docs/featured.md
Repeated H1, bold centred intro, logo at 320 px from a 2 MB PNG One plain intro paragraph; logo at 160 px on the right, from a 320 px, 30 KB JPEG copy
Font Awesome icons in every heading Plain headings
Eight news items with emoji The three most recent; docs/news.md holds all of them
Awesome Works as emoji-led paragraphs Same works, same order, as a plain list; the nine older entries stay folded
Results: five tables The V2 Hermes leaderboard and the overall paper results (V1, six models), then a pointer to docs/results.md
Reproduction: two paths, pass criterion One paragraph and the one-shot clawbench-reproduce command, then a pointer to docs/reproduce.md
Comparison table with nine benchmarks The positioning paragraph, then a pointer to docs/comparison.md
Community: large for-the-badge buttons; "Star this repo" button Three text links; the star button is removed

Moved to docs/

New page Content Pointer in the README
docs/results.md V2 under OpenClaw, V1 under the Hermes harness, the per-category breakdown of the paper results, V1 task categories Results
docs/reproduce.md Path A, Path B, the one-shot command, and the pass criterion Reproduce the leaderboard
docs/comparison.md The comparison with WebArena, GAIA, Mind2Web and others How ClawBench compares
docs/featured.md The 37 curated lists, Paper of the Day, DeepWiki Header, below the sister-project line

docs/README.md links the new pages. docs/cli.md, docs/faq.md and docs/harbor.md now point to reproduce.md directly. Every existing README anchor (#reproduce-the-leaderboard, #awesome-works-using-clawbench, #news, #citation and the legacy quick-start anchors) is kept, so old links still land.

Design notes

  • Palette: D8E2DC, FFE5D9, FFCAD4, F4ACB7, 9D8189. White small text on 9D8189 is about 3.5:1, so the badge body is one step darker (7A6369, about 5.5:1); the four pastels mark the icon cells.
  • The wordmark, tagline and badge text are EB Garamond glyph outlines. GitHub shows repository SVGs through <img>, which cannot load web fonts. No font file is committed; the SIL Open Font License permits outlining.
  • The tagline uses GitHub's own text colours (#1f2328 light, #f0f6fc dark), so it reads like the surrounding text in either theme.

Not changed

  • docs/README.zh-CN.md still uses the old header; only its citation changed. The header needs a matching pass by someone who maintains the Chinese text. The hero SVGs and heading icons stay in assets/ because that page uses them.
  • assets/clawbench_logo.png and assets/social-card.png are unchanged.

Citation

The BibTeX in the README and in docs/README.zh-CN.md now cites the EMNLP 2026 Findings paper (@inproceedings{zhang2026clawbench, ...}, pages 9386–9408) instead of the arXiv preprint.

Verification

  • python scripts/ci/check_markdown_links.py: all 324 repo-relative Markdown links resolve.
  • Rendered through GitHub's Markdown API in light and dark. The <picture> theme switching was confirmed on github.com with the same structure in TIGER-AI-Lab/WebsiteBench.
  • No Python changes; ruff and pyright are unaffected.

Replace the gradient banner and badge wall with a typeset wordmark,
tagline and four palette badges drawn from EB Garamond outlines, show
the logo at 160 px from a 30 KB copy, and drop the heading icons.

Move the results archive, reproduction guide, benchmark comparison,
works using ClawBench and curated-list mentions into docs/, and make
docs/news.md the complete news archive. Existing README anchors stay.
Restore the Awesome Works list in the README as a plain list, keeping
the nine older entries folded, and drop docs/awesome-works.md.

Where material moved to docs/, the README now names the page in place:
featured lists, the results archive, the reproduction guide, the news
archive, and a short "How ClawBench compares" section that links the
full comparison table.
@reacher-z
reacher-z force-pushed the docs/readme-restyle branch from 9afd01f to 25c9da5 Compare November 4, 2026 20:09

@reacher-z reacher-z left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

@Perry2004 plz double check this review

@reacher-z
reacher-z merged commit 62a228e into main Nov 5, 2026
2 checks passed
@reacher-z
reacher-z deleted the docs/readme-restyle branch November 5, 2026 08:32
@github-project-automation github-project-automation Bot moved this from Todo to Done in ClawBench Nov 5, 2026
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