Skip to content

docs: clarify that pnpm/yarn are valid options for installing CLI - #536

Merged
ChristianLuciani merged 1 commit into
mainfrom
vibe/docs-pnpm-yarn-options-f3fa9e
Nov 14, 2026
Merged

ChristianLuciani merged 1 commit into
mainfrom
vibe/docs-pnpm-yarn-options-f3fa9e

Conversation

@ChristianLuciani

Copy link
Copy Markdown
Owner

Add notes in user-facing documentation to clarify that while npm is recommended (as it comes with Node.js), users can also install @profile-as-code/cli with pnpm or yarn.

This addresses the 'best of both worlds' approach: pnpm for developers (monorepo needs) and npm for users (simplicity and adoption), while acknowledging that all three package managers work for installing the published package from npm registry.

Files changed:

  • docs/USER-GUIDE.md: Updated Option A with pnpm/yarn alternatives
  • docs/START-HERE.md: Added pnpm/yarn notes in Route 1 and Route 4
  • docs/TUTORIAL.md: Added pnpm/yarn tip in Step 1
  • packages/cli/README.md: Updated Install section with alternatives
  • site/index.html: Added comment about pnpm/yarn in quick start
  • site/es/index.html: Added comment about pnpm/yarn in quick start (Spanish)

Add notes in user-facing documentation (USER-GUIDE.md, START-HERE.md,
TUTORIAL.md, packages/cli/README.md, and site pages) to clarify that
while npm is recommended (as it comes with Node.js), users can also
install @profile-as-code/cli with pnpm or yarn.

This addresses the 'best of both worlds' approach: pnpm for developers
(monorepo needs) and npm for users (simplicity and adoption), while
acknowledging that all three package managers work for installing
the published package from npm registry.

Files changed:
- docs/USER-GUIDE.md: Updated Option A with pnpm/yarn alternatives
- docs/START-HERE.md: Added pnpm/yarn notes in Route 1 and Route 4
- docs/TUTORIAL.md: Added pnpm/yarn tip in Step 1
- packages/cli/README.md: Updated Install section with alternatives
- site/index.html: Added comment about pnpm/yarn in quick start
- site/es/index.html: Added comment about pnpm/yarn in quick start (Spanish)

Co-authored-by: ChristianLuciani <ChristianLuciani@users.noreply.github.com>
Signed-off-by: Vibe Nuage Agent <vibe@mistral.ai>
@ChristianLuciani
ChristianLuciani force-pushed the vibe/docs-pnpm-yarn-options-f3fa9e branch from 02781b0 to 7713cd9 Compare November 14, 2026 16:36
@ChristianLuciani
ChristianLuciani merged commit c401638 into main Nov 14, 2026
2 checks passed
@ChristianLuciani
ChristianLuciani deleted the vibe/docs-pnpm-yarn-options-f3fa9e branch November 14, 2026 16:40
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