Skip to content

Simplify results and installation - #8

Merged
maveryn merged 1 commit into
mainfrom
agent/simplify-readme-results
Jul 27, 2026
Merged

Simplify results and installation#8
maveryn merged 1 commit into
mainfrom
agent/simplify-readme-results

Conversation

@maveryn

@maveryn maveryn commented Jul 27, 2026

Copy link
Copy Markdown
Owner

Summary

  • restore the Hugging Face Collection hero link in place of the redundant Results/Reproduce badge
  • make external benchmark transfer the single results section on the README and project page
  • reduce TRACE in-distribution validation to one concise paragraph below the transfer summary
  • keep the 24-benchmark table collapsed and retain the full comparison link
  • shorten README installation to the standard clone/install block and move reproducibility, export, virtual-environment, and Python 3.14 details into Quickstart
  • extend visibility tests to preserve the simplified presentation

Why

External transfer is the central result, while the separate in-distribution heading and table repeated nearby evidence. The detailed installation variants are valuable reference material but interrupt the README’s main path.

Validation

  • python -m pytest -q tests/test_visibility_surfaces.py tests/test_docs_site.py tests/test_public_paper.py — 27 passed
  • mkdocs build --strict --site-dir site — passed
  • documentation/repository hygiene scan — passed
  • generated homepage confirms the Collection button, single transfer heading, brief TRACE validation summary, and collapsed benchmark table

@maveryn
maveryn marked this pull request as ready for review July 27, 2026 05:44
@maveryn
maveryn merged commit cacbc06 into main Jul 27, 2026
11 checks passed
@maveryn
maveryn deleted the agent/simplify-readme-results branch July 27, 2026 05:44
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