Repository navigation
docs: refresh the README hero banner - #508
Conversation
Co-authored-by: Codex <noreply@openai.com>
gloryfromca
left a comment
gloryfromca
left a comment
There was a problem hiding this comment.
No blockers; this can merge as far as I am concerned.
Reviewed the complete github/main...HEAD diff and both README top sections. The approved issue asset is used consistently in the English and Chinese READMEs, remains publicly retrievable as a valid 1536x656 PNG, and preserves the surrounding badge and language-link layout.
Coverage included the applicable AGENTS.md/CLAUDE.md rules, the diff, linked issue acceptance criteria, prior banner-update history, backward compatibility, test integrity, and architecture/domain constraints. There are no code callers or architecture changes in this docs-only patch, and no tests were changed or weakened.
Verification: uv run --frozen --python 3.12 --extra dev pytest tests/test_readme_scope_canon.py -x -q passed (2 tests); pre-commit for both README files passed; git diff --check github/main...HEAD passed; and the large-file, source-language, and commit-message scripts passed directly. The local image download returned HTTP 200. make itself is unavailable in this review environment, so I invoked the relevant underlying repository scripts directly.
ZuyiZhou
left a comment
ZuyiZhou
left a comment
There was a problem hiding this comment.
Docs-only banner swap; new attachment resolves as a valid PNG (1536×656) and all checks pass. LGTM.
## Summary Replace the first image in README.md and README.zh-CN.md with the updated Raven banner, "One raven, a whole flock of specialists." Both versions use the same GitHub-hosted attachment. ## Type - [ ] Fix - [ ] Feature - [x] Docs - [ ] CI / tooling - [ ] Refactor - [ ] Other ## Verification - [x] Relevant tests pass locally - [x] Relevant lint / type checks pass locally - [x] User-facing docs or screenshots are updated when needed - `uv run --frozen --extra dev pytest tests/test_readme_scope_canon.py -x -q`: 2 passed. - `uv run --frozen --extra dev pre-commit run --files README.md README.zh-CN.md`: all applicable hooks passed. - `git diff --check origin/main...HEAD`: passed. - `make check-commits check-large-files check-source-language`: passed. GitHub confirmed the attachment upload. Download timeouts prevented a complete comparison with the supplied PNG. Browser rendering at desktop and mobile widths has not been checked. ## Risk - [x] Security impact considered - [x] Backward compatibility considered - [x] Rollback path is clear for risky changes This changes the README banner only. The image is hosted as a GitHub attachment. Reverting the two URL edits restores the previous banner. ## Related Issues Fixes #126 Co-authored-by: Codex <noreply@openai.com>
Summary
Replace the first image in README.md and README.zh-CN.md with the updated Raven banner, "One raven, a whole flock of specialists." Both versions use the same GitHub-hosted attachment.
Type
Verification
Relevant tests pass locally
Relevant lint / type checks pass locally
User-facing docs or screenshots are updated when needed
uv run --frozen --extra dev pytest tests/test_readme_scope_canon.py -x -q: 2 passed.uv run --frozen --extra dev pre-commit run --files README.md README.zh-CN.md: all applicable hooks passed.git diff --check origin/main...HEAD: passed.make check-commits check-large-files check-source-language: passed.GitHub confirmed the attachment upload. Download timeouts prevented a complete comparison with the supplied PNG. Browser rendering at desktop and mobile widths has not been checked.
Risk
This changes the README banner only. The image is hosted as a GitHub attachment. Reverting the two URL edits restores the previous banner.
Related Issues
Fixes #126