Skip to content

Redesign README for non-programmers - #9

Merged
alanhoff merged 1 commit into
mainfrom
codex/readme-revamp
Aug 28, 2026
Merged

alanhoff merged 1 commit into
mainfrom
codex/readme-revamp

Conversation

@alanhoff

Copy link
Copy Markdown
Owner

Summary

  • rebuild the README around plain-language value, fit, installation, and first use
  • add a custom checked-progress hero image
  • keep the install contract test aligned with the approved presentation

Validation

  • ruff check --no-cache src skill/scripts tests
  • python3 -m unittest discover -s tests -v (67/67)
  • python3 -m compileall -q src skill/scripts tests
  • independent visual score: 85/100 vs 44/100 baseline (93.18% gain)

Copilot AI lite review requested due to automatic review settings August 28, 2026 12:21
@alanhoff
alanhoff merged commit 5fd4ca7 into main Aug 28, 2026
5 checks passed
@alanhoff
alanhoff deleted the codex/readme-revamp branch August 28, 2026 12:22

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The README updates are consistent with existing repo artifacts (including the hero image and compose configuration), and the contract test change correctly enforces the new approved install-section format.

Pull request overview

This PR rewrites the repository README to be more approachable for non-programmers (value/fit/first use), adds a new hero image, and updates the contract test to keep the “install in one prompt” presentation locked to the approved README format.

Changes:

  • Redesigned README.md structure and wording (new hero image, clearer “fit”, “first task”, FAQ, and reference details).
  • Updated the install section format to a fenced text code block under the heading “Install in one prompt”.
  • Adjusted the install-surface contract test to match the new README heading and code-block formatting.
File summaries
File Description
README.md Plain-language README redesign, new hero image reference, and updated install/usage presentation.
tests/test_contract.py Updates the README “install prompt” contract assertions to match the new heading and fenced code block.
Review details
  • Files reviewed: 2/3 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

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.

2 participants