Repository navigation
docs: use shared README media - #568
Merged
Merged
Conversation
Use shared release and Unity SVGs without embedding stale versions in the generated GitHub README. Keep documentation chips and release preparation in sync with the selected stable or preview channel.
- Use the Pages URL in both documentation languages and the generated README. - Keep release preparation and validation on the matching Pages channel.
- Load animated WebP banners and PNG fallbacks from shared Pages hosting. - Remove duplicated outputs and preserve the native website header.
VPDPersonal
marked this pull request as ready for review
November 8, 2026 19:36
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.
Why
The package duplicates banner and badge artwork and edits SVG text on every release. Shared generated media keeps GitHub READMEs consistent while documentation keeps its documented version and native theme behavior.
What
Start with:
Website/docs/README.md, thenWebsite/src/remark/introBanner.js,scripts/set-version.shandWebsite/scripts/github-readme.mjs.The website retains versioned labels, an anchor for stable releases and its own theme; GitHub loads the shared live SVGs and banner. The producer renders shared artwork and configurable project text, caching unchanged output. Its Pages artifact contains banners and badges together.
Verification
npm --prefix Website ci→ installed successfully.Repository script tests → 141 passed, including stable/preview transitions and repair runs.
Website tests → 102 passed, including shared-banner recognition and live GitHub badge links and alt text.
README synchronization and translation checks → passed.
EN/RU production builds → passed; CSS minimizer warns about unchanged cqi styles.
Package-file, sample, version, minimum-Unity, contrast and skill checks → passed (existing contrast baselines retained).
README local-path checker → 48 paths checked, 0 errors.
Headless Chrome → three badges, both themes, 1280px/375px; no overflow or JavaScript errors.
Shared banner → 2560×768 PNG fallback and 1280×384 looping WebP, 196 frames at 40ms.
Shared-media gallery → all images load at desktop/375px with no overflow or JavaScript errors.
git diff --checkfor the changed files → passed.No Unity test input changed;
unity-quickis not needed.Published media → producer fix: restore the original banner dot scale VPDPersonal#3 deployed; banner and badge URLs return HTTP 200.
Final diff review → no actionable findings; every required GitHub check passed.
Automated review → Claude action failed before producing a verdict; no inline findings were produced. The final diff was reviewed locally.