[DOCS] Add Windows as first-class install option across docs site#278
[DOCS] Add Windows as first-class install option across docs site#278danielmeppiel merged 4 commits intomainfrom
Conversation
Co-authored-by: danielmeppiel <51440732+danielmeppiel@users.noreply.github.com>
…-start, and installation pages Co-authored-by: danielmeppiel <51440732+danielmeppiel@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the documentation site to make Windows a first-class installation option alongside macOS/Linux, ensuring Windows users see official install methods prominently on the landing page and getting-started docs.
Changes:
- Added platform tabs/labels so Windows install commands are shown alongside macOS/Linux instead of being buried.
- Updated installation guidance to include Scoop and reorganized install methods for parity across platforms.
- Expanded manual install docs to explicitly include Windows in the platform/archive listing.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/src/content/docs/index.mdx | Replaces single-platform quick start with tabs for macOS/Linux vs Windows install commands. |
| docs/src/content/docs/getting-started/quick-start.md | Adds explicit platform-labeled install blocks and mentions Scoop in the install-methods linkout. |
| docs/src/content/docs/getting-started/installation.md | Broadens install docs to include Windows throughout, adds package manager section (Homebrew + Scoop), and updates manual install platform table. |
Comments suppressed due to low confidence (2)
docs/src/content/docs/getting-started/installation.md:10
- The requirements line claims Windows supports both x86_64 and ARM64, but the release workflow and Windows installer only publish/use the x86_64 artifact (ARM64 relies on x86_64 emulation). Please update this to avoid implying a native Windows ARM64 build exists (or explicitly note the emulation requirement).
- macOS, Linux, or Windows (x86_64 or ARM64)
docs/src/content/docs/getting-started/installation.md:28
- This sentence says the installer detects Intel/ARM on Windows, but install.ps1 downloads a fixed
apm-windows-x86_64.zipasset (no architecture detection). Suggest rewording to reflect: macOS/Linux detect Intel vs ARM; Windows installs x86_64 (ARM64 via emulation).
The installer automatically detects your platform (macOS/Linux/Windows, Intel/ARM), downloads the latest binary, and adds `apm` to your `PATH`.
|
@copilot you missed the project's root README.md - you have my explicit permission to propose a change there and change it and commit + push to this pr branch. |
… Windows command Co-authored-by: danielmeppiel <51440732+danielmeppiel@users.noreply.github.com>
Done in 8205b49. The README Windows PowerShell command is now normalized to |
|
@copilot The archive-name table now includes Windows, but it’s introduced right after the macOS/Linux tar -xz example (“Replace apm-darwin-arm64 with the archive name for your platform”). That phrasing can mislead Windows users into trying the macOS/Linux commands. Consider scoping the sentence/table to macOS/Linux only, or splitting the table by OS. This issue also appears in the following locations of the same file: line 10 |
This was addressed in 8205b49 — the archive table and its introductory sentence ("Replace |
…ation) Three files conflicted with main's PR #278 (Windows documentation normalization): 1. README.md — Adopted main's simplified `irm ... | iex` PowerShell command (commit 8205b49 removed the `powershell -ExecutionPolicy Bypass -c` wrapper). 2. docs/src/content/docs/getting-started/installation.md — Adopted main's restructured install page: Windows in description/requirements, clean section headings, simplified irm command, Homebrew section, scoped troubleshooting to macOS/Linux, narrowed manual binary table. 3. src/apm_cli/models/dependency.py — No change needed on our side; the docstring line `- Local paths are returned as-is -> ./packages/my-pkg` was already present from our previous merge resolution. Main simply doesn't have this line (it's our new feature documentation). Co-authored-by: danielmeppiel <51440732+danielmeppiel@users.noreply.github.com>
Windows has an official PowerShell installer and Scoop package, but the docs site treated it as an afterthought. Landing page, quick start, and installation pages all defaulted to Linux/macOS curl commands with Windows buried or absent.
Description
docs/src/content/docs/index.mdxcurlQuick Start block with a<Tabs>component (macOS/Linux | Windows) — Windows is now equally prominent on the landing pagedocs/src/content/docs/getting-started/quick-start.mdmacOS / Linux/Windows (PowerShell))docs/src/content/docs/getting-started/installation.mdirm … | iexformtar-based section was misleading(macOS / Linux)where applicable; removed a broken empty### Verify Installationsub-headingREADME.mdirm … | iexform (consistent with the docs site)curlcommandType of change
Testing
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.