Skip to content

Streamline the repository front page - #40

Merged
fly1d merged 1 commit into
mainfrom
codex/streamline-readme
Sep 9, 2026
Merged

fly1d merged 1 commit into
mainfrom
codex/streamline-readme

Conversation

@fly1d

@fly1d fly1d commented Sep 9, 2026

Copy link
Copy Markdown
Owner

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

  • Merge product output and tool-selection guidance into one When to use it section.
  • Present install, Doctor, bounded reduction, and validation as one continuous first-run path.
  • Remove the repeated standalone install section.
  • Collapse community navigation into four routes: start, pilot, ask/share, and contribute.
  • Fix the benchmark contributor-guide anchor.
  • Record the documentation change under 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.

@fly1d
fly1d merged commit 5aabe0c into main Sep 9, 2026
10 checks passed
@fly1d
fly1d deleted the codex/streamline-readme branch September 9, 2026 05:46
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