Skip to content

Clarify npx vs pnpm in quickstart docs#2

Open
cryppadotta wants to merge 1 commit intomainfrom
quickstart-npx-clarity
Open

Clarify npx vs pnpm in quickstart docs#2
cryppadotta wants to merge 1 commit intomainfrom
quickstart-npx-clarity

Conversation

@cryppadotta
Copy link
Copy Markdown
Contributor

Summary

  • Restructured quickstart to lead with npx paperclipai for end users (the most common path)
  • Added explicit "start again later" command (npx paperclipai run)
  • Added callout explaining npx (end users) vs pnpm (contributors in cloned repo)
  • Moved Local Development to a clearly labeled "Contributors" section
  • Addresses Discord confusion where users tried pnpm paperclipai outside the repo

Test plan

  • Verify npx paperclipai and npx paperclipai run commands work as documented
  • Verify docs render correctly on the documentation site
  • Confirm the npx/pnpm callout is clear to new users

🤖 Generated with Claude Code

Restructure the quickstart guide to lead with `npx paperclipai` for end
users, clearly separate the Local Development section for contributors,
and add an explicit callout explaining when to use npx vs pnpm. This
addresses user confusion reported in Discord where users tried `pnpm
paperclipai` outside the cloned repo and got "Command not found" errors.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.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