Repository navigation
Redesign README for non-programmers - #9
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 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.mdstructure and wording (new hero image, clearer “fit”, “first task”, FAQ, and reference details). - Updated the install section format to a fenced
textcode 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.
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
Validation
ruff check --no-cache src skill/scripts testspython3 -m unittest discover -s tests -v(67/67)python3 -m compileall -q src skill/scripts tests