Repository navigation
docs: restyle the README header and move reference sections to docs - #481
Merged
Merged
Conversation
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
force-pushed
the
docs/readme-restyle
branch
from
November 4, 2026 20:09
9afd01f to
25c9da5
Compare
Perry2004
approved these changes
Nov 4, 2026
reacher-z
commented
Nov 5, 2026
reacher-z
left a comment
Collaborator
Author
There was a problem hiding this comment.
@Perry2004 plz double check this review
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
assets/hero-*.svg)docs/featured.mddocs/news.mdholds all of themdocs/results.mdclawbench-reproducecommand, then a pointer todocs/reproduce.mddocs/comparison.mdfor-the-badgebuttons; "Star this repo" buttonMoved to
docs/docs/results.mddocs/reproduce.mddocs/comparison.mddocs/featured.mddocs/README.mdlinks the new pages.docs/cli.md,docs/faq.mdanddocs/harbor.mdnow point toreproduce.mddirectly. Every existing README anchor (#reproduce-the-leaderboard,#awesome-works-using-clawbench,#news,#citationand the legacy quick-start anchors) is kept, so old links still land.Design notes
D8E2DC,FFE5D9,FFCAD4,F4ACB7,9D8189. White small text on9D8189is about 3.5:1, so the badge body is one step darker (7A6369, about 5.5:1); the four pastels mark the icon cells.<img>, which cannot load web fonts. No font file is committed; the SIL Open Font License permits outlining.#1f2328light,#f0f6fcdark), so it reads like the surrounding text in either theme.Not changed
docs/README.zh-CN.mdstill 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 inassets/because that page uses them.assets/clawbench_logo.pngandassets/social-card.pngare unchanged.Citation
The BibTeX in the README and in
docs/README.zh-CN.mdnow 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.<picture>theme switching was confirmed on github.com with the same structure in TIGER-AI-Lab/WebsiteBench.