-
Notifications
You must be signed in to change notification settings - Fork 965
docs: clarify setup instructions as distinct approaches #42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
docs: clarify setup instructions as distinct approaches #42
Conversation
Reword 'Option 1/Option 2' to 'Approach A/Approach B' to clarify these are alternative setup strategies, not sequential steps. - Approach A: Project-local (recommended for teams) - Approach B: Global (for personal use) Fixes snarktank#19
Greptile SummaryThis PR successfully clarifies that the two setup approaches are mutually exclusive alternatives, addressing the confusion from issue #19. The changes rename "Option 1/2" to "Approach A/B" and add clear guidance about when to use each approach (teams vs personal use). However, the PR introduces a critical bug in Approach A: the command The documentation improvements are valuable, but the path bug must be fixed before merge to prevent a broken user experience. Confidence Score: 2/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant User
participant README
participant FileSystem
User->>README: Read Setup section
README->>User: "Choose one of the following approaches"
alt Approach A: Project-local setup
User->>README: Select Approach A (teams)
README->>User: Copy ralph.sh to scripts/ralph/
User->>FileSystem: cp ralph.sh scripts/ralph/
README->>User: Copy prompt templates
User->>FileSystem: cp prompt.md/CLAUDE.md to scripts/ralph/
README->>User: Copy skills to project
User->>FileSystem: cp -r skills .claude/skills/ OR .amp/skills/
Note over User,FileSystem: BUG: Creates nested skills/skills/ structure
FileSystem-->>User: Skills at wrong path (.claude/skills/skills/prd)
else Approach B: Global setup
User->>README: Select Approach B (personal)
README->>User: Copy skills to global config
User->>FileSystem: cp -r skills/prd ~/.config/amp/skills/
User->>FileSystem: cp -r skills/ralph ~/.config/amp/skills/
FileSystem-->>User: Skills correctly at ~/.config/amp/skills/prd
README->>User: Then copy ralph.sh to each project
User->>FileSystem: cp ralph.sh to project
end
User->>User: Attempt to use Ralph
alt Approach A was chosen
User->>FileSystem: Ralph looks for skills
FileSystem-->>User: Skills not found (wrong path)
else Approach B was chosen
User->>FileSystem: Ralph looks for skills
FileSystem-->>User: Skills found correctly
end
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1 file reviewed, 1 comment
| cp -r /path/to/ralph/skills .claude/skills/ # For Claude Code | ||
| # OR | ||
| cp -r /path/to/ralph/skills .amp/skills/ # For Amp |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: incorrect path - creates nested skills/skills/ directory structure
copying the entire skills directory will create .claude/skills/skills/prd/ instead of .claude/skills/prd/
| cp -r /path/to/ralph/skills .claude/skills/ # For Claude Code | |
| # OR | |
| cp -r /path/to/ralph/skills .amp/skills/ # For Amp | |
| # Also copy the skills to your project | |
| cp -r /path/to/ralph/skills/prd .claude/skills/ # For Claude Code | |
| cp -r /path/to/ralph/skills/ralph .claude/skills/ | |
| # OR | |
| cp -r /path/to/ralph/skills/prd .amp/skills/ # For Amp | |
| cp -r /path/to/ralph/skills/ralph .amp/skills/ |
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 40:42
Comment:
**logic:** incorrect path - creates nested `skills/skills/` directory structure
copying the entire `skills` directory will create `.claude/skills/skills/prd/` instead of `.claude/skills/prd/`
```suggestion
# Also copy the skills to your project
cp -r /path/to/ralph/skills/prd .claude/skills/ # For Claude Code
cp -r /path/to/ralph/skills/ralph .claude/skills/
# OR
cp -r /path/to/ralph/skills/prd .amp/skills/ # For Amp
cp -r /path/to/ralph/skills/ralph .amp/skills/
```
How can I resolve this? If you propose a fix, please make it concise.
Summary
Addresses #19 - Rewords the Setup section to clarify that the two options are alternative approaches, not sequential steps.
Changes
Before
Users were confused whether both steps were required.
After
Now it's clear these are mutually exclusive paths.