Repository navigation
docs: fix Windows PowerShell install + refresh version examples - #333
Merged
Merged
Conversation
The Windows install snippet moved the binary into %USERPROFILE%\bin without creating that directory or putting it on PATH, so a fresh Windows box failed at Move-Item with "Could not find a part of the path" (DirectoryNotFoundException), and the closing `canton-devkit version` would not have resolved either. Create the target dir, move with -Force, add it to PATH for the current session and persist it for future terminals, bump the stale example tag, and note the Docker Desktop + WSL 2 requirement for localnet. Verified by reproducing the failure and confirming the corrected steps on Windows.
The Linux/macOS/APT install snippets still pinned the stale v0.12.2 tag while the Windows one was current, so the examples now agree. These are placeholders users replace with the latest release tag.
srikanth-bitdynamics
changed the title
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.
The bug (Windows install)
Following the Windows install steps in
getting-started.mdon a clean Windows box fails:The snippet moved the binary into
%USERPROFILE%\binbut never created that directory (Move-Itemdoesn't create a missing destination →DirectoryNotFoundException), and~\binisn't onPATHby default, so the closingcanton-devkit versionwouldn't have resolved either. The macOS/Linux steps work because they use/usr/local/bin, which exists and is onPATH.Fix: create
%USERPROFILE%\binif missing,Move-Item -Forceinto it, add it toPATHfor the current session and persist it for future terminals, and note the Docker Desktop + WSL 2 requirement forlocalnet.Also: refresh stale version examples
The macOS/Linux/APT/
.debinstall snippets still pinnedv0.12.2while the Windows one was current. Bumped every example to the current latest tag v0.17.4 so they agree. These remain placeholders users replace with the latest release tag.Verification
Reproduced the original Windows failure and confirmed the corrected steps install and run
canton-devkit version. Docs site builds clean (npm run build); the renderedgetting-startedpage no longer contains the brokenMove-Itemand shows a consistent version across all channels.Found while testing the Windows release package.