Skip to content

docs: add local and npx install paths to migration guide#397

Closed
diberry wants to merge 1 commit intobradygaster:devfrom
diberry:squad/197-migration-guide-install-paths
Closed

docs: add local and npx install paths to migration guide#397
diberry wants to merge 1 commit intobradygaster:devfrom
diberry:squad/197-migration-guide-install-paths

Conversation

@diberry
Copy link
Copy Markdown
Collaborator

@diberry diberry commented Mar 14, 2026

Summary

This PR addresses item 6 from issue #197 with minimal, surgical changes to the migration guide.

Changes

Node.js version alignment:

  • Updated all references from Node.js 18 to Node.js 20 (matches package.json engines requirement)

Version pin cleanup:

  • Replaced hardcoded @0.8.18 with @latest in user-facing install commands
  • Kept historical version reference in "What's New in v0.8.18" section title
  • Updated CI/CD example to use @latest with advice to pin to a specific version

Install path documentation:

  • Added local (--save-dev) and npx alternatives in Scenario 2 and Scenario 3
  • Kept global install as "recommended" but showed all three options clearly

Scope

This PR only covers the docs gap (item 6 from #197). Other items:

Testing

  • Validated Markdown syntax
  • Verified all relative links still resolve
  • Confirmed no structural changes to the document

Closes #197

- Add local (--save-dev) and npx alternatives alongside global install
- Update Node.js version requirement from 18 to 20 (matches package.json)
- Replace hardcoded @0.8.18 version pins with @latest

Closes bradygaster#197 (item 6 — docs scope only)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@diberry
Copy link
Copy Markdown
Collaborator Author

diberry commented Mar 14, 2026

Consolidated into PR #389 — all changes from this PR have been merged into the consolidated docs quality PR.

@diberry diberry closed this Mar 14, 2026
bradygaster pushed a commit that referenced this pull request Mar 15, 2026
Merges diberry's consolidated docs PR #389.
Closes #258, Fixes #351, Addresses #197 item 6, Addresses #398.
19 files, -1,471 net lines. Bloat reduction across guide.md, tips-and-tricks.md, sample-prompts.md, and more.
Supersedes PRs #390, #391, #392, #395, #397, #399.
tamirdresher pushed a commit to tamirdresher/squad that referenced this pull request Mar 16, 2026
* chore(squad): quality review findings — 7 issues filed

Quality audit complete: 5 agents assessed CLI across testing, coverage, stability, accessibility, UX.
Results: 4 P0 blockers (bradygaster#365bradygaster#368), 3 P1 items (bradygaster#369bradygaster#371).
Blocking: Waingro dead sessions, ErrorBoundary, dropped input; Marquez help text consistency.

Changes:
- Logged session summary to .squad/log/2026-02-24T0205-quality-review-complete.md
- Updated .squad/identity/now.md with quality review findings and new issue numbers

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* chore(squad): merge decision — Marquez UX audit findings

Quality assessment merged from inbox (Grade B): 11 improvements (3 P0, 4 P1, 4 P2). help text, stub commands, vocabulary, separators, roster.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* test: add speed gate tests for impatient user journey

18 speed gate tests enforcing time budgets across the user journey:
- Help scanability, init ceremony speed, welcome data loading
- Input parsing latency, ghost retry bounds, error actionability
- Version output speed and format

Filed issues: bradygaster#387, bradygaster#395, bradygaster#397, bradygaster#399, bradygaster#401, bradygaster#403

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
tamirdresher pushed a commit to tamirdresher/squad that referenced this pull request Mar 16, 2026
…) (bradygaster#476)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.

2 participants