Streamline the repository front page - #40
Merged
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.
Requested outcome
Make the repository front page faster to scan without removing the evidence, safety boundaries, or next actions needed to evaluate ReproMin.
Context and impact
The README had grown to 221 lines and repeated installation, first-run, value, and community navigation across several sections. That made qualified visitors work harder to understand whether ReproMin fits and how to try it. The benchmark guide also linked to a contributor heading that no longer exists.
Changes
When to use itsection.Unreleased.The README moves from 221 lines / about 1,200 words to 169 lines / about 900 words.
Evidence and validation
python3 scripts/check_docs.py: passed for 50 Markdown files.PYTHONPATH=src uv run --isolated --offline --with pytest python -m pytest -q tests/test_documentation_check.py tests/test_packaging.py tests/test_community_templates.py: 28 passed.git diff --check: passed.Risk and limits
Documentation only. CLI, Action, package, report, and reducer behavior are unchanged. Deep reference documentation remains available; this change only shortens the visitor path through the front page.
Done when
CI passes and a reader can move from the project promise to a demo, fit decision, complete first-run skeleton, or one clear community route without crossing duplicated sections.
Material analysis, implementation, and PR drafting used OpenAI Codex; the maintainer reviewed the public text and validation evidence.