Skip to content

docs: offer platform-specific installation on the homepage - #29

Merged
NaNIsaac merged 5 commits into
mainfrom
docs/home-install-platforms
Oct 23, 2026
Merged

NaNIsaac merged 5 commits into
mainfrom
docs/home-install-platforms

Conversation

@NaNIsaac

@NaNIsaac NaNIsaac commented Oct 22, 2026 •

Copy link
Copy Markdown
Owner

Tier: low

  • Homepage only: the hero install command becomes a Windows / Linux, macOS, Termux / Python (uv) selector.
  • The docs workflow now builds the site on pull requests; deploy still runs only from main.
  • No change to the CLI, the install scripts, README or other docs pages.

Changes

  • Replace the single Python-only homepage command with tabs for Windows, Linux/macOS/Termux, and Python (uv).
  • Match the documented recommended native installation path while keeping the Python option.
  • Update both English and Korean homepages and link to the complete installation guide.
  • Preserve the existing homepage layout, VitePress theme, and copy interaction.
  • Resolve the installation-guide link under the /codigest/ base path (it pointed at a 404 on Pages).
  • Select the visitor's platform after hydration, use $ for the POSIX prompts, announce the copy result to screen readers.
  • Wrap Korean on the homepage between words instead of between syllables.
  • Build the site on pull requests in docs.yml without configuring or deploying Pages.

Validation

  • cd site && npm ci && npm run build passes locally (VitePress 1.6.4, Node 24).
  • Headless Chromium render of en/ko home and installation at desktop and mobile widths, dark and light: no console errors, no failed requests, no horizontal overflow; keyboard selection and copy work. Results and screenshots in the comment below.
  • Internal link check over the whole build: one remaining broken anchor, which is on main already and handled separately.
  • Not checked: real screen readers, Safari/Firefox, the deployed Pages site.

The 'All installation options' link was a raw href without the /codigest/
base, so it pointed at a 404 on GitHub Pages. Also select the visitor's
platform after hydration, use $ for the POSIX prompts, announce the copy
result to screen readers, and wrap Korean on the homepage between words.
@NaNIsaac

Copy link
Copy Markdown
Owner Author

Rendered check (headless Chromium, npm ci && npm run build + vitepress preview)

Pages: en/ko home and installation, at 1440x900 and 390x844 (mobile, DPR 2), dark and light: 16 renders.

Check Before (7c5d572) After (5e146ae)
Build passes passes
Console errors, failed requests none none
Horizontal page overflow none none
Installer "All installation options" link /installation (404 under /codigest/) /codigest/installation, /codigest/ko/installation
Keyboard: Tab to a platform, Enter selects it works, focus ring visible works
Copy button writes the selected command works works, result announced in a live region
Default platform Windows for everyone Windows on Windows, Linux/macOS/Termux elsewhere (checked with Linux, macOS and Android user agents)
Korean hero on mobile breaks inside words ("도 / 구") wraps between words
Internal links in the whole build 3 bad 1 bad, pre-existing on main (/ko/rust-port#설치, filed separately)

Korean home, mobile, light

Before After

After

Keyboard focus on the second platform button:

Not checked: real screen readers, Safari/Firefox, and the deployed Pages site (the docs workflow now builds PRs; deploy still runs only from main).

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