mining guide: a Windows path without WSL2, and a one-command skill install - #16
Closed
adamtpang wants to merge 2 commits into
Closed
mining guide: a Windows path without WSL2, and a one-command skill install#16adamtpang wants to merge 2 commits into
adamtpang wants to merge 2 commits into
Conversation
…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>
Author
|
Folded into #15 so the mining docs land as one review instead of two. Closing this one; no changes lost. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Two additions to the top of the mining guide, both aimed at the first sixty seconds of a newcomer's experience. No existing instructions change.
1. A path for Windows users without WSL2
The guide opens with "Works on macOS and Linux (including WSL2 on Windows)", and the setup script genuinely needs WSL2. A Windows user without it reaches the end of the intro with nothing to run.
There is already a good answer: the Miner App. It is the most-downloaded artifact of the
miner-v0.6.1release (21 downloads ofquantus_miner_windows.zip, against 8 Linux and 3 macOS), it bundles node download, identity, mining, and rewards in one window, and it needs no terminal at all.The guide never mentions it.
docs/guides/miner-app.mdisdraft: true, sohttps://docs.quantus.com/guides/miner-appcurrently returns 404, which is why this links the GitHub release rather than the docs page. If the draft flag lifts, this line should point at the guide instead.2. A one-command install for the mining skill
The guide already tells agent users to press Copy Context and paste. For Claude Code specifically the skill can simply be installed, which is faster and survives across sessions:
Then
/mining.Validation
Ran the one-liner against an isolated
HOME: exit 0, 16508 bytes, 323 lines, frontmatter intact (name: mining,user_invocable: true), and the installed file keeps its seven references to the setup script and release URLs. Thedocs.quantus.com/skills/mining-skill.mdendpoint returns 200.Note
This pairs with #15, which corrects a stale version claim inside that same skill file. The two are independent and can merge in either order.