Skip to content

mining docs: correct the pre-auth claim, add a Windows path and a PowerShell-safe install - #15

Closed
adamtpang wants to merge 3 commits into
Quantus-Network:mainfrom
adamtpang:fix/mining-skill-current-releases
Closed

mining docs: correct the pre-auth claim, add a Windows path and a PowerShell-safe install#15
adamtpang wants to merge 3 commits into
Quantus-Network:mainfrom
adamtpang:fix/mining-skill-current-releases

Conversation

@adamtpang

@adamtpang adamtpang commented Sep 4, 2026

Copy link
Copy Markdown

Overview

Three small changes to the mining docs, all aimed at the first few minutes of a newcomer's experience. No existing instructions are rewritten.

1. The skill says today's releases are pre-auth. They are not.

static/skills/mining-skill.md line 19 names node v0.9.0-endless-sky and miner v3.3.1 as what releases/latest currently returns. That stopped being true with node v0.10.0 (2026-08-13) and miner v4.0.2 (2026-09-01), both of which require miner QUIC auth.

An agent following the skill as written expects a pre-auth pair, skips waiting for miner-auth-token, and omits --auth-token-file. On today's binaries the miner then exits immediately. The claim is now corrected and dated so it cannot rot silently again. Line 52's "(today's latest)" label carried the same assumption in shorthand and is renamed "(pre-auth pair)". The probe logic is untouched and already handles every case correctly.

Reproduced on a real Windows install: miner-cli 2.1.2 beside quantus-node 0.10.0, which the skill's own probe classifies as "Mixed: stop".

2. Windows users without WSL2 have no path

The mining guide opens with "Works on macOS and Linux (including WSL2 on Windows)", and the setup script genuinely needs WSL2. A Windows reader without it finishes the intro with nothing to run.

The Miner App already covers that case, bundling node download, identity, mining, and rewards in one window with no terminal, and it is the most-downloaded artifact of miner-v0.6.1: 21 downloads of quantus_miner_windows.zip against 8 Linux and 3 macOS. The guide never mentions it.

This links the GitHub release rather than docs/guides/miner-app.md, because that page is draft: true and https://docs.quantus.com/guides/miner-app currently returns 404. If the draft flag is lifted, this link should point at the guide instead. Is the flag intentional?

3. The skill install is one command, but only in bash

The guide tells agent users to press Copy Context and paste. For Claude Code the skill can simply be installed, which is faster and persists across sessions.

The bash one-liner fails on Windows PowerShell 5.1, still the default shell on Windows, for two independent reasons: && is a parser error there, and curl is an alias for Invoke-WebRequest, which does not accept -fsSL. A Windows reader in the shell they already have open hits a parser error before anything downloads. Both variants are now given, with a note recording why they differ.

Validation

Every command tested on this machine, writing to an explicit path each time:

Shell Command Result
Git Bash bash line exit 0, 16508 bytes
PowerShell 5.1 bash line parser error at &&, then curl alias
PowerShell 5.1 PowerShell line exit 0, 16508 bytes
PowerShell 7.6 PowerShell line exit 0

The installed file keeps its frontmatter (name: mining, user_invocable: true) and its seven references to the setup script and release URLs. https://docs.quantus.com/skills/mining-skill.md returns 200.

Line 19 stated that GitHub releases/latest are pre-auth (node
v0.9.0-endless-sky, miner v3.3.1). That has been false since node v0.10.0
(2026-08-13) and miner v4.0.2 (2026-09-01), both of which require miner
QUIC auth. An agent following the skill as written would expect a
pre-auth pair and skip waiting for miner-auth-token.

The probe logic is unchanged; only the factual claim about what "latest"
is today is corrected, and dated so it cannot silently rot the same way.
Line 52's "(today's latest)" label on the both-no branch is renamed
"(pre-auth pair)" for the same reason.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
adamtpang and others added 2 commits September 4, 2026 17:24
…stall

Two additions at the top of the guide, no existing instructions changed.

The guide says it works on "macOS and Linux (including WSL2 on Windows)",
and the setup script does need WSL2. A Windows user without it finishes the
intro with nothing to run, even though the Miner App already covers that
case and is the most-downloaded artifact of miner-v0.6.1 (21 Windows
downloads, against 8 Linux and 3 macOS). Added a pointer to it.

It links the GitHub release rather than docs/guides/miner-app.md because
that page is draft: true and currently 404s. If the flag lifts, the link
should move to the guide.

The guide also tells agent users to press Copy Context and paste. For
Claude Code the skill can just be installed, which is faster and persists
across sessions. Verified against an isolated HOME: exit 0, 323 lines,
frontmatter intact.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…ly runs

The one-command install was bash only. On Windows PowerShell 5.1, still the
default shell on Windows, it fails twice: && is a parser error there, and
curl is an alias for Invoke-WebRequest, which does not accept -fsSL. A
Windows reader following the guide in the shell they already have open hits
a parser error before anything downloads.

Tested on this machine, writing to an explicit path each time:

  Git Bash          bash line          exit 0, 16508 bytes
  PowerShell 5.1    bash line          parser error at &&, then curl alias
  PowerShell 5.1    PowerShell line    exit 0, 16508 bytes
  PowerShell 7.6    PowerShell line    exit 0

The PowerShell version invokes curl.exe explicitly and separates statements
with a semicolon, so it runs on both 5.1 and 7. The note under the block
records why, so nobody later collapses the two blocks back into one that
only works in bash.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@adamtpang adamtpang changed the title mining-skill: correct the pre-auth claim about current releases mining docs: correct the pre-auth claim, add a Windows path and a PowerShell-safe install Sep 4, 2026
@adamtpang

Copy link
Copy Markdown
Author

Closing: #14 supersedes all three changes here, and does each one better.

  • The stale pre-auth claim is fixed at the root by pinning node v0.10.0 and miner v4.0.2 in mining-compatibility.json, rather than by editing a sentence that would rot again.
  • Native Windows users get a real destination, since Make mining a verified one-command path #14 publishes the miner-app page instead of leaving it draft: true.
  • My PowerShell variant is moot by design: Make mining a verified one-command path #14 never hands a PowerShell user a bash command, it routes them to WSL2 or the desktop app.

Both PRs also edit the same two files heavily, so keeping this open would only create a conflict. No changes lost.

@adamtpang adamtpang closed this Sep 4, 2026
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