Skip to content

docs: stop the setup instructions assuming the reader's platform - #31

Merged
yashau merged 1 commit into
mainfrom
claude/contributing-platform-neutral
Aug 20, 2026
Merged

docs: stop the setup instructions assuming the reader's platform#31
yashau merged 1 commit into
mainfrom
claude/contributing-platform-neutral

Conversation

@yashau

@yashau yashau commented Aug 20, 2026

Copy link
Copy Markdown
Owner

CONTRIBUTING.md

The first command was winget install jdx.mise, with brew and the install script demoted to a trailing comment on the same line — so a contributor on macOS or Linux met a Windows package manager as step one of a bash block. The three ways to install mise now get equal billing, each labelled with the platforms it serves, and the repository steps that follow sit in their own block because those genuinely are identical everywhere.

The mirror-image gap

docs/getting-started/install.md had the same problem pointing the other way, in two places, both of them a POSIX-only step arriving after platform-neutral setup:

  • From a release tarball unpacks a .tar.gz and runs sudo mv.
  • Build from source walks the reader through mise — which is cross-platform — and then ends at sudo install -m 755 … with no alternative.

Windows releases are .zip and the binary is prk.exe, so both now say so. Verified against cli-release.yml rather than assumed: it zips *-pc-windows-msvc and tars every other target.

Both files also link mise's install page now, instead of naming one package manager and leaving the reader to work out whether theirs is covered.

Checked and deliberately left alone

  • README.md — already lists every channel with a platform comment, brew first, and puts Scoop in its own powershell block.
  • docs/contributing/development.md — says "install mise" with a link and names no package manager at all. This is the version CONTRIBUTING.md now matches.
  • AGENTS.md — neutral setup; its two Windows mentions are properly conditional.
  • The %APPDATA%\prick rows in install.md and docs/reference/cli/sign-in.md, and the PowerShell blocks for Scoop, WinGet and completions — these sit in per-platform tables or shell-labelled blocks, which is the disclosure doing its job. Not a defect.
  • scripts/ being "Node ESM helpers, not bash — they must run on Windows" is a real constraint on contributors, not an assumption about them.

Checks

mise run docs:build is clean (42 pages), along with fmt:check:js and lint:typos. Pre-push ran clippy, the Rust suite, typecheck and the Worker suite green.

One thing worth knowing for anyone editing prose here: vp fmt does not reflow Markdown paragraphs, so a rewritten sentence has to be wrapped to the 100-column printWidth by hand. Both files are at the same over-100 line count as before this change — the remainder are pre-existing table rows.

🤖 Generated with Claude Code

The first command in CONTRIBUTING.md was `winget install jdx.mise`, with brew
and the install script demoted to a trailing comment on the same line. A
contributor on macOS or Linux met a Windows package manager as step one of a
`bash` block. The three ways to install mise now get equal billing, each
labelled with the platforms it serves, and the repository steps that follow
are in their own block because they genuinely are identical everywhere.

`docs/getting-started/install.md` had the mirror-image gap in two places, both
after platform-neutral setup: the release-tarball section unpacks a
`.tar.gz` and runs `sudo mv`, and the build-from-source section ends at
`sudo install -m 755`. Windows releases are `.zip` and the binary is
`prk.exe`, so both now say so. Verified against `cli-release.yml`, which zips
`*-pc-windows-msvc` and tars everything else.

Both files also now link mise's install page rather than naming a package
manager and leaving the reader to guess whether theirs is covered.

Checked and left alone: `README.md`, `docs/contributing/development.md` and
`AGENTS.md` are already neutral, and the `%APPDATA%` and PowerShell entries
elsewhere sit in per-platform tables or shell-labelled blocks, which is the
disclosure doing its job.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@yashau
yashau merged commit 9fafa3a into main Aug 20, 2026
16 checks passed
@yashau
yashau deleted the claude/contributing-platform-neutral branch August 20, 2026 20:30
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