docs: rewrite project documentation for clarity - #1
Merged
Conversation
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.
Summary
Why
The previous README assumed familiarity with AlphaEvolve, Gate Runner, and quantitative evaluation terminology. It explained the implementation before clearly explaining the project’s purpose. Some status and scoring language had also become inaccurate as the implementation progressed.
This rewrite gives new readers a direct explanation of the experiment while preserving the rigor needed for security, reproducibility, and evaluation design.
Technical clarifications
Validation
uv run ruff check .uv run mypy srcuv run pytest— 69 passed, 5 environment-dependent tests skippeduv lock --check