From 3f8ce8cdecbc77004ec6337880cca8bbeaaca109 Mon Sep 17 00:00:00 2001 From: Justin Gordon Date: Mon, 20 Oct 2025 22:20:52 -1000 Subject: [PATCH 1/2] Add foreman/overmind requirement note to Getting Started guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit New developers following the Getting Started guide encounter the "can't find executable foreman" error when running ./bin/dev, but this requirement is only documented in the "Installation into an existing Rails app" guide. This commit adds a clear note in the "Start the app" section to ensure developers know they need overmind or foreman installed before running bin/dev, improving the getting started experience. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- docs/getting-started.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 15c24c6c5f..763957a24e 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -71,9 +71,11 @@ Start the app: ```bash bin/dev help bin/dev # start with hmr -bin/dev static # +bin/dev static # start with statically created bundles (no HMR) ``` +> **Note:** Ensure that you have `overmind` or `foreman` installed to run `bin/dev`. + ## Basic Usage ### Configuration From 0f67526f557f4f9c5bf68a2dce50c34333d470ce Mon Sep 17 00:00:00 2001 From: Justin Gordon Date: Wed, 22 Oct 2025 21:13:43 -1000 Subject: [PATCH 2/2] Add installation instructions and improve note placement MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Following review feedback, this commit: - Adds installation instructions for both overmind and foreman - Moves the note before the command block so developers see prerequisites first - Confirms file ends with newline as required by CLAUDE.md Installation instructions include: - overmind: brew install for macOS with link to full installation guide - foreman: gem install with important note about global installation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- docs/getting-started.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 763957a24e..f1c36ac58c 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -66,6 +66,11 @@ cd PROJECT_NAME bundle exec rails generate react_on_rails:install ``` +> **Note:** Ensure that you have `overmind` or `foreman` installed to run `bin/dev`. +> +> - **overmind**: `brew install overmind` (macOS) or see [installation guide](https://github.com/DarthSim/overmind#installation) +> - **foreman**: `gem install foreman` (install globally, not in your project bundle - [details](https://github.com/ddollar/foreman/wiki/Don't-Bundle-Foreman)) + Start the app: ```bash @@ -74,8 +79,6 @@ bin/dev # start with hmr bin/dev static # start with statically created bundles (no HMR) ``` -> **Note:** Ensure that you have `overmind` or `foreman` installed to run `bin/dev`. - ## Basic Usage ### Configuration