Skip to content

docs: use shared README media - #568

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

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

  • Load animated banners, PNG fallbacks and badges from GitHub Pages.
  • Remove duplicated banner images and badge SVGs.
  • Generate version-independent GitHub alt text and current release links.
  • Switch Pages badge URLs when preparing stable or preview releases.
  • Preserve the native website header and versioned documentation chips.

Start with: Website/docs/README.md, then Website/src/remark/introBanner.js, scripts/set-version.sh and Website/scripts/github-readme.mjs.

Desktop 375px
Documentation badges on desktop Documentation badges on mobile

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 --check for the changed files → passed.

  • No Unity test input changed; unity-quick is 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.

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.
@github-actions github-actions Bot added area: ci CI / GitHub Actions workflows area: docs Documentation content: README, CHANGELOG, Documentation/ area: website Docusaurus site code (Website/) type: documentation Documentation only labels Nov 8, 2026
- 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 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 99baabd into main Nov 8, 2026
22 of 23 checks 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

area: ci CI / GitHub Actions workflows area: docs Documentation content: README, CHANGELOG, Documentation/ area: website Docusaurus site code (Website/) type: documentation Documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant