docs: add bilingual image-rich README - #6
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a full Simplified Chinese README with a language switch, replaces README SVG image references with committed PNG assets (including a real PointMass HTML report screenshot), and ensures the new docs assets are included in the source distribution.
Changes:
- Added
README.zh-CN.mdwith a complete bilingual-aligned project overview and navigation. - Updated
README.mdto add a language toggle and swap SVG README images for PNGs (plus a report screenshot). - Updated packaging includes to ship the Chinese README and PNG assets in the sdist.
Reviewed changes
Copilot reviewed 3 out of 7 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.zh-CN.md | New Simplified Chinese README with image assets and two-way language switch. |
| README.md | Adds language toggle; switches README images from SVG to PNG and adds report screenshot. |
| pyproject.toml | Includes the Chinese README and PNG assets in the source distribution. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Why
The repository landing page should provide actual raster assets and a complete native-language experience instead of a short translated paragraph. The report preview is captured from the project's real committed output rather than a fabricated mockup.
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; 79 local links)mkdocs build --strictuv buildtwine checkREADME.zh-CN.mdand all four PNG assets are present in the sdist