Skip to content

README declutter: promote Awesome Works, weekly citation scan, fold long sections - #282

Open
reacher-z wants to merge 4 commits into
mainfrom
docs/readme-declutter
Open

README declutter: promote Awesome Works, weekly citation scan, fold long sections#282
reacher-z wants to merge 4 commits into
mainfrom
docs/readme-declutter

Conversation

@reacher-z

Copy link
Copy Markdown
Collaborator

Implements the maintainer's README review (decision log D1–D9, exported 2026-08-15).

What changed

Awesome Works (D2, D3)

  • Section moved from line ~981 (after both FAQ blocks) to directly after News, where readers actually see it; institution-emphasis line bolded at the top.
  • 5 new citing papers added (all arXiv-verified): From Chatbot to Digital Colleague (Tencent Youtu Lab, Tsinghua & SYSU), PAST-Bench (Princeton & UChicago), SecRespond (Tongyi Lab, Alibaba Cloud & HKUST), EnterpriseClawBench (Horizon Research & Frontis.AI), ContinualSkillBench (PKU & BIGAI).
  • ⚠️ Reviewer notes: (1) D2 selections were given but the overall verdict was left unset in the review export — please double-check the 5 additions; 3 candidates were excluded per the maintainer's editorial criteria. (2) PAST-Bench's PDF prints no affiliations; Princeton/UChicago is inferred from the senior authors (Gen-Verse org) — please confirm before merge.

Auto-update pipeline (D1)

  • scripts/update_awesome_works.py + .github/workflows/awesome-works.yml: every Sunday, fetch citing papers of arXiv:2604.08523 from Semantic Scholar, diff against README + previously filed scan issues, and open an awesome-works issue cc @Perry2004 for curation. Never edits the README directly. Dry-run already found 10 candidates (incl. ClawTrack, MyPCBench, Harness-Bench), so expect a first issue on the first scheduled run.

Declutter (D4–D8)

  • Logo: side-by-side hero (image left 200px, tagline right); source PNG compressed 2.0 MB → 140 KB.
  • News: 7 newest visible, 7 older under an Earlier news fold.
  • Badges: 9 core visible (Star / arXiv / Daily Paper / Dataset / Trace / claw-bench.com / PyPI / Discord / License — Discord & Trace kept per review); counters, Codespaces, DeepWiki moved into the existing fold.
  • CLI: 3 common commands visible, the rest under All commands; Reproduce Path A/B and the Harbor quick-start block folded (scope extension of D6 in the same spirit — flag if unwanted).
  • Duplicates removed: the two FAQ sections merged into one details-style FAQ (#frequently-asked-questions anchor preserved; no unique Q&A dropped), HarnessBench banner and the second clone one-liner removed.

zh-CN (D9)

  • docs/README.zh-CN.md mirrors all structural changes; its Awesome Works section links to the English list to avoid dual maintenance.

Verification

  • GitHub-rendered branch page screenshot-checked (hero table, badge row, folds, Awesome Works placement).
  • <details> open/close balanced (38/38 en, 28/28 zh); nav anchors (#frequently-asked-questions, #常见问题) preserved.
  • Scan script exercised against the live Semantic Scholar API.

- Move Awesome Works after News; bold institution line at section top; add 5
  curated citing papers (Digital Colleague, PAST-Bench, SecRespond,
  EnterpriseClawBench, ContinualSkillBench)
- Trim visible badges to 9 core; counters/Codespaces/DeepWiki into the fold
- Logo: side-by-side layout (image left, tagline right), 320->200 display,
  source PNG 2.0MB -> 140KB
- News: 7 newest visible, rest under 'Earlier news'
- CLI: 3 common commands visible, rest folded; Reproduce Path A/B and Harbor
  quick-start blocks folded
- Merge duplicate FAQ sections into one details-style FAQ (anchor preserved);
  drop duplicate HarnessBench banner and clone one-liner
- Mirror equivalent changes in docs/README.zh-CN.md
Sunday cron fetches citing papers of arXiv:2604.08523, diffs against README
entries and previously filed scan issues, and opens an 'awesome-works' issue
cc @Perry2004 for curation. Never edits the README directly.
MyPCBench (CMU), ClawTrack (Meituan), Mach-Mind-4-Flash Technical Report
(Li Auto), Harness-Bench (Peking University & Qiyuan Tech) — all arXiv-verified.
Institution line gains Princeton and Carnegie Mellon (en + zh-CN).
@reacher-z

Copy link
Copy Markdown
Collaborator Author

Follow-up per maintainer: added 4 more citing works surfaced by the Semantic Scholar scan (not in Google Scholar's cited-by yet) — MyPCBench (Carnegie Mellon), ClawTrack (Meituan), Mach-Mind-4-Flash Technical Report (Li Auto), Harness-Bench (Peking University & Qiyuan Tech). All abs URLs, affiliations, and code/project links verified against the arXiv HTML first pages. Institution line now includes Princeton and Carnegie Mellon. Three scan candidates deliberately not added under the maintainers' inclusion criteria (RedundancyBench, On-Time-Within-Budget, AbO-DDoS). Awesome Works now totals 26 entries.

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