Skip to content

docs(readme): match the FastTools installation layout - #36

Merged
VPDPersonal merged 1 commit into
mainfrom
docs/installation-walkthrough
Nov 12, 2026
Merged

VPDPersonal merged 1 commit into
mainfrom
docs/installation-walkthrough

Conversation

@VPDPersonal

@VPDPersonal VPDPersonal commented Nov 12, 2026 •

Copy link
Copy Markdown
Owner

Important

Why. HSM's installation section is a long text-only guide. Match FastTools' illustrated Package Manager layout while keeping UniTask first and the preview channel explicit.

What

  • Place the shared animation beside three native installation steps.
  • Keep copyable URLs, requirements, version pinning, and troubleshooting together.
Before After
Before After
The HSM installation uses the same illustration and steps layout as FastTools.
Narrow layout at 375px

Narrow installation section
Long Git URLs scroll within their copyable code blocks.

Verification
  • node scripts/check-package.mjs — passed.

  • node scripts/check-version.mjs — version files agree on 0.0.1-alpha.7.

  • README path checker — three local paths checked, zero errors.

  • GitHub Markdown API output rendered with GitHub Markdown CSS at 1012px, 375px and 324px — images decoded, no page overflow, disclosures open correctly.

  • Verified the immutable HSM preview tag, its root UPM manifest and the UniTask 2.5.11 tag and package manifest.

  • Shared media build and browser checks passed; HSM's complete 8.2-second WebP loop and 1792×920 PNG fallback validated.

  • Unity Editor package installation was not rerun; this PR changes documentation only.

  • git diff --check — passed.

  • Producer deployment succeeded; both published media URLs returned HTTP 200 through GitHub's image proxy. Downloaded PNG dimensions and the complete WebP animation validated.

@VPDPersonal
VPDPersonal marked this pull request as ready for review November 12, 2026 13:30
@VPDPersonal
VPDPersonal merged commit 724b210 into main Nov 12, 2026
9 checks passed
@VPDPersonal
VPDPersonal deleted the docs/installation-walkthrough branch November 12, 2026 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant