Skip to content

docs: use shared README media - #41

Merged
VPDPersonal merged 3 commits into
mainfrom
codex/shared-readme-badges
Nov 8, 2026
Merged

VPDPersonal merged 3 commits into
mainfrom
codex/shared-readme-badges

Conversation

@VPDPersonal

@VPDPersonal VPDPersonal commented Nov 8, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Load the animated README banner, PNG fallback, Unity, stable release and MIT badges from shared GitHub Pages hosting in both README languages.
  • Keep release links and alt text current without rewriting version numbers.
  • Remove the duplicated banner images and three local SVGs.

Notes for review

Shared media is deployed from VPDPersonal/VPDPersonal#3; the banner and badge URLs return HTTP 200.

The central workflow reads published release tags and publishes SVGs to GitHub Pages hourly, without committing generated files. It renders banners from shared source artwork and configurable project text, caching unchanged output. The package's release workflow already preserves absolute image URLs when producing UPM READMEs.

Start with: README.md, then README_RU.md.

Verification
  • README local-path checker → 34 local paths checked, 0 errors.

  • EN/RU banner URLs, badge destinations and release targets match.

  • git diff --check for the changed documentation → passed.

  • Shared SVGs were generated from release 1.1.1 and its manifest, then inspected in both themes.

  • Shared banner → 2560×768 PNG fallback and 1280×384 looping WebP, 196 frames at 40ms.

  • Producer integration tests → banners and all seven badges remain in the same Pages artifact after a badge refresh.

  • Release README generation preserves absolute image URLs.

  • Final diff review → no actionable findings; unit-tests passed.

  • Automated review → repository workflow is disabled manually; the final diff was reviewed locally.

@VPDPersonal VPDPersonal changed the title docs: use shared README badges docs: use shared README media Nov 8, 2026
@VPDPersonal
VPDPersonal marked this pull request as ready for review November 8, 2026 19:36
@VPDPersonal
VPDPersonal merged commit 15bd21d into main Nov 8, 2026
1 check passed
@VPDPersonal
VPDPersonal deleted the codex/shared-readme-badges branch November 8, 2026 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant