Repository navigation
docs: a download card on the quickstart, the Windows zip on the install page - #6988
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
There was a problem hiding this comment.
🟡 Changes recommended
The Linux link now downloads a .deb directly, leaving non-Debian users without a link to the AppImage option referenced in the instructions.
1 open issue
What changed in this PR
This PR makes Studio downloads easier to find and updates the getting-started documentation to match the current installation options.
Changes:
- Adds a prominent download card to the quickstart and removes billing details from both pages.
- Corrects Windows instructions to describe extracting the zip and documents Windows on Arm support.
- Adds direct platform-specific download links to the installation tabs.
| File | Description |
|---|---|
docs/studio-app/index.mdx |
Updates platform downloads, Windows installation steps, and account information. |
docs/quickstart.mdx |
Adds the download card, removes the billing note, and updates Windows support. |
Review effort: Balanced
| [Download the app for Linux](https://hyperframes.studio/studio/download?os=deb&src=docs-install). | ||
| You get `HyperFrames-amd64.deb` for 64-bit Intel and AMD computers on Debian, Ubuntu and their | ||
| relatives. |
jrusso1020
left a comment
jrusso1020
left a comment
There was a problem hiding this comment.
Reviewed at 59d21b3a94d153b26968401d0fd0e52acffd2d45.
No blocker found. The quickstart card renders below the film, and the install page's real Windows/Linux tabs show the updated steps and separate package links at 1440 and 390 px in light/dark Chromium previews. Copilot's missing-AppImage-link concern is addressed at this head by docs/studio-app/index.mdx:76.
Live verification: all eight distinct download URLs rendered across these pages return 307 to the expected platform file (tested with a Windows browser UA and the prefetch header). The four explicit platform destinations serve successful 206 range responses: Install-HyperFrames.dmg, HyperFrames-win-x64.zip, HyperFrames-amd64.deb, HyperFrames-x86_64.AppImage. The card's automatic URL selects the expected file for Mac, Windows x64, Windows Arm and Linux UAs; an unidentified client falls back to the download landing page. The live ZIP's central directory contains HyperFrames-win32-x64/HyperFrames.exe, matching the instructions. HFI#6242's merged source exposes the same Windows download for Arm, and HFI#7653's merged route change establishes ZIP delivery.
Validation: real preview, Playwright tab interactions/screenshots, live HTTP redirects/range reads and ZIP directory inspection. I did not install or sign in on Mac, Windows/Arm or Linux; serving the Arm download does not independently prove runtime compatibility.
Need: accurate and reachable install path · Size: focused · Reuse: shipped download route and standard Card/Tabs · Simpler: already minimal · Structure: fine.
Risk: low — docs-only links/instructions verified against live files; no installer code changes.
Verdict: COMMENT — clean; no blocker found.
Reasoning: The visible instructions and download links match the delivered files. Approval is left to an authorized stamper.
— hf-review
![heygengenesis[bot]](https://avatars.githubusercontent.com/in/2913576?s=60&v=4){kind=small}
There was a problem hiding this comment.
Verdict: APPROVE · 0 blocker · 0 important · 0 nits · 59d21b3a
Copilot's AppImage point (older head) is fixed: the Linux tab links both os=deb and os=linux.
Scope
PR preview in Chromium (1440 light, 390 dark): the quickstart card links ?src=docs-quickstart-top, the billing note is gone, and the Mac/Windows/Linux install tabs show the new steps and links. Live with a prefetch header: os=mac|windows|deb|linux → .dmg/-win-x64.zip/.deb/.AppImage, all 200. Bare link by UA: Mac/Win/Linux → matching file, iPhone → landing. The zip's central directory has HyperFrames-win32-x64/HyperFrames.exe. hyperframes-internal#7653 confirms the zip copy updates itself. No other Install-HyperFrames.exe or "Arm not available" text in docs/README. Not done: a real Windows or Arm install (the PR body says so). CI green.
— Genesis (reviewing for @ukimsanov)
What
Changes to the two "get started" pages:
src=docs-quickstart-top.Install-HyperFrames.exe. Every Windows download link has servedHyperFrames-win-x64.zipsince hyperframes-internal chore(deps): override tinypool to 2.1.2, bump vite 6.4.5 and vitest 4.1.12 #7653. The steps now say to extract the zip, open theHyperFrames-win32-x64folder and runHyperFrames.exe.os=mac,os=windows,os=deb, taggedsrc=docs-install). The Linux tab's AppImage line links its file too (os=linux). Before, each one sent people to the download landing page to pick again.Why
Related work
Refs hyperframes-internal #7653 (Windows serves the zip) and #6242 (Windows on Arm). Follows #6860 (the top-bar Download button).
How
docs/quickstart.mdx: one Mintlify<Card>; the<Note>is removed.docs/quickstart.mdx: the systems line.docs/studio-app/index.mdx: the "Free" and "Windows" bullets, three Download steps and the Windows install step.Test plan
mint validatepasses.mint devin Chrome at 1440px: the card shows under the film and the billing note is gone. The Windows tab shows the zip steps.os=mac→Install-HyperFrames.dmg, one file for both Apple Silicon and Intel Macs (the route hands out the feed's universal file);os=windows→HyperFrames-win-x64.zip;os=deb→HyperFrames-amd64.deb;os=linux→HyperFrames-x86_64.AppImage.HyperFrames-win32-x64/folder withHyperFrames.exeinside.