Skip to content

Conversation

@justin808
Copy link
Member

@justin808 justin808 commented Nov 2, 2025

Summary

This PR addresses the issue where new developers following the Getting Started guides encounter the "can't find executable foreman" error when running ./bin/dev. The PR adds clear documentation about the foreman/overmind prerequisite in both the Quick Start and Using React on Rails guides.

Supersedes: #1870 (rebased on latest master after docs reorganization in #1860)

Changes

Quick Start Guide (docs/getting-started/quick-start.md)

  • Added "Foreman or Overmind" to Prerequisites section
  • Added installation instructions before the bin/dev command with:
    • brew install overmind for macOS users
    • gem install foreman for global installation
    • Links to detailed installation guides for both tools
    • Important note about global installation for foreman

Using React on Rails Guide (docs/getting-started/using-react-on-rails.md)

  • Added note in Development Workflow section about foreman/overmind requirement
  • Included quick installation commands
  • Cross-referenced Quick Start guide for detailed instructions

Impact

  • Existing installations: No impact - documentation only
  • New installations: Better developer experience with clear requirements upfront, preventing common "can't find executable" errors

Testing

  • Verified all files end with newline characters (CLAUDE.md requirement)
  • Passed all pre-commit hooks (prettier, rubocop, trailing-newlines)
  • Manually verified markdown formatting is correct

🤖 Generated with Claude Code


This change is Reviewable

New developers following the Getting Started guides encounter the "can't
find executable foreman" error when running ./bin/dev. This commit adds
clear documentation about this prerequisite in both the Quick Start and
Using React on Rails guides.

Changes:
- Add foreman/overmind to Prerequisites section in quick-start.md
- Add installation instructions before bin/dev command in quick-start.md
- Add note with installation info in using-react-on-rails.md
- Include links to detailed installation guides for both tools
- Emphasize global installation requirement for foreman

This improves the developer onboarding experience by surfacing this
requirement before developers encounter errors.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 2, 2025

Warning

Rate limit exceeded

@justin808 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 11 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between a59bbb7 and 1c129b4.

📒 Files selected for processing (2)
  • docs/getting-started/quick-start.md (2 hunks)
  • docs/getting-started/using-react-on-rails.md (1 hunks)
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch justin808/add-foreman-note-rebased

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@justin808 justin808 merged commit 7825688 into master Nov 2, 2025
18 checks passed
@justin808 justin808 deleted the justin808/add-foreman-note-rebased branch November 2, 2025 20:26
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