Skip to content

docs: add npm installation as recommended method with self-contained guides#331

Merged
marc0olo merged 2 commits intomainfrom
marc0olo/docs-npm-installation
Feb 3, 2026
Merged

docs: add npm installation as recommended method with self-contained guides#331
marc0olo merged 2 commits intomainfrom
marc0olo/docs-npm-installation

Conversation

@marc0olo
Copy link
Member

@marc0olo marc0olo commented Feb 2, 2026

Summary

Promotes npm as the recommended installation method for icp-cli across all documentation.

Key changes:

  • README, Quickstart, Tutorial: Now include npm install commands directly instead of linking to the Installation Guide
  • Installation Guide: Restructured with "Quick Install (Recommended)" section using npm, alternatives moved below
  • Prerequisites: Added Node.js requirement; Windows (WSL + Docker) and Linux (system deps) notes now upfront
  • URLs: Shell script installers updated to use /releases/latest/ instead of versioned paths
    • This is to prepare for the upcoming non-beta release

Why: The previous quickstart would fail silently—it didn't install ic-wasm or mops, which are required by templates. Now each doc is self-contained and works end-to-end.

@marc0olo marc0olo requested a review from a team as a code owner February 2, 2026 21:49
@marc0olo
Copy link
Member Author

marc0olo commented Feb 2, 2026

let's avoid merging this before #325 is merged

@marc0olo marc0olo enabled auto-merge (squash) February 3, 2026 09:05
@marc0olo marc0olo merged commit 6400c62 into main Feb 3, 2026
76 checks passed
@marc0olo marc0olo deleted the marc0olo/docs-npm-installation branch February 3, 2026 15:04
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.

3 participants