docs: redesign README showcase - #5
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR redesigns the repository README into a more scannable “landing page” that highlights the project’s motivation, quick-start path, example results, and documentation navigation, and adds new SVG visuals to support that narrative.
Changes:
- Reworked
README.mdstructure with a hero header, quick start, results preview, CLI map, reproducibility guarantees, roadmap, citation, and Chinese overview. - Added three new accessible SVG diagrams (hero, evaluation pipeline, diagnostic profile) and embedded them in the README.
- Updated the validation/checklist section to reflect the project’s current CI/test/quality commands and thresholds.
Reviewed changes
Copilot reviewed 1 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Full README landing-page redesign with new navigation, visuals, and updated validation/citation sections. |
| docs/assets/wamprobe-hero.svg | New accessible SVG hero graphic referenced at the top of the README. |
| docs/assets/evaluation-pipeline.svg | New evaluation-pipeline diagram embedded in the README. |
| docs/assets/diagnostic-profile.svg | New diagnostic-profile visualization embedded in the README. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+260
to
+261
| - Python 3.11–3.13 CI, linting, strict typing, coverage, schema validation, link checking, | ||
| CodeQL, and strict documentation builds. |
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.
What changed
v0.1.0rc1implementation and explicitly preserve benchmark limitationsWhy
The previous README was technically thorough but visually flat and difficult for a new visitor to scan. This revision makes the core research question, runnable path, evidence, and contribution entry points understandable from the repository front page.
Validation
ruff format --check .ruff check .mypypytest --cov=wamprobe --cov-report=term-missing --cov-fail-under=85(76 passed)python scripts/validate_repository.py(7 schema instances; 51 local links)mkdocs build --strictxmllint --noout docs/assets/*.svguv buildtwine check