Skip to content

docs: load shared installation walkthroughs - #569

Merged
VPDPersonal merged 1 commit into
mainfrom
codex/shared-installation-panels
Nov 9, 2026
Merged

VPDPersonal merged 1 commit into
mainfrom
codex/shared-installation-panels

Conversation

@VPDPersonal

Copy link
Copy Markdown
Owner

Important

Why

The GitHub installation recording is duplicated locally and has to be re-recorded when the package changes channels. Select shared generated media from the copyable install command so the illustrated stable/preview URL stays aligned automatically.

What

  • Select shared WebP and PNG from the install command's channel.
  • Preserve native numbered steps and the copyable URL.
  • Remove the duplicated recording and manual re-recording warning.
  • Keep the documentation site's interactive installation panel.

Start with: Website/scripts/github-readme.mjs, then Website/scripts/sync-readme.mjs and scripts/set-version.sh.

Before After
Current FastTools panel Shared FastTools panel

Matching full-URL key frames in GitHub's Markdown styles. The shared picture has a static PNG fallback; the steps and copyable URL stay native text.

Narrow README layout

Shared installation at 375px

The existing table retains all three instructions and the copyable command without page overflow.

Verification
  • Website tests → 102 passed, including stable/preview installation image selection.
  • Repository script tests → 141 passed, including release-channel transitions and generated README checks.
  • README synchronization and translation checks → passed.
  • EN/RU production builds → passed; existing cqi minimizer warnings retained.
  • Package, samples, versions, minimum Unity, contrast and skills checks → passed with existing contrast baselines.
  • README local-path checks → 47 paths, 0 errors.
  • GitHub Markdown API → picture, WebP source and PNG fallback retained.
  • Actual GitHub Markdown styles → before/after at 1080px/375px, dark/light; decoded images, native steps, copyable URL, no overflow.
  • Local feature recorder syntax and git diff --check → passed.
  • No Unity test inputs changed; unity-quick is not needed.

- Select the shared stable or preview image from the install command.
- Keep native steps and copyable URLs with a PNG fallback.
- Remove duplicated recording output and manual channel recording steps.
@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
@VPDPersonal
VPDPersonal marked this pull request as ready for review November 9, 2026 10:22
@VPDPersonal
VPDPersonal merged commit 07e68e5 into main Nov 9, 2026
20 of 21 checks passed
@VPDPersonal
VPDPersonal deleted the codex/shared-installation-panels branch November 9, 2026 10:24
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