Skip to content

Commit e8cea9d

Browse files
committed
Fix markdownlint issues: wrap long lines and add language specifiers
1 parent af855f9 commit e8cea9d

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

AI_AGENT_INSTRUCTIONS.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# 🤖 AI Agent Instructions: React on Rails Setup
22

3-
_Super concise, copy-paste instructions for AI agents to set up React on Rails in common scenarios._
3+
_Super concise, copy-paste instructions for AI agents to set up React on Rails in
4+
common scenarios._
45

56
## 🔍 **Before Starting: Check Current Versions**
67

@@ -15,7 +16,8 @@ gem search shakapacker --remote
1516
# shakapacker ~> 8.3
1617
```
1718

18-
**⚠️ Version Flexibility:** These instructions use `~> X.Y` which allows patch updates. Always check for latest versions before starting a new project.
19+
**⚠️ Version Flexibility:** These instructions use `~> X.Y` which allows patch
20+
updates. Always check for latest versions before starting a new project.
1921

2022
## 🚨 **CRITICAL: Installation Order Matters**
2123

@@ -28,13 +30,13 @@ gem search shakapacker --remote
2830

2931
**✅ Correct Order:**
3032

31-
```
33+
```text
3234
Shakapacker → package.json created → React on Rails → success
3335
```
3436

3537
**❌ Wrong Order:**
3638

37-
```
39+
```text
3840
React on Rails → no package.json → ERROR: package.json not found
3941
```
4042

@@ -61,7 +63,8 @@ rails generate react_on_rails:install
6163
bin/dev
6264
```
6365

64-
**✅ Success Check:** Visit `http://localhost:3000/hello_world` → Should see "Hello World" from React
66+
**✅ Success Check:** Visit `http://localhost:3000/hello_world` → Should see
67+
"Hello World" from React
6568

6669
**📁 Generated Files:**
6770

@@ -214,7 +217,7 @@ bin/dev
214217

215218
### Essential Files Structure
216219

217-
```
220+
```text
218221
app/
219222
├── controllers/hello_world_controller.rb
220223
├── views/hello_world/index.html.erb
@@ -231,7 +234,8 @@ app/
231234

232235
### Version Requirements
233236

234-
- Rails 7+ (Rails 8 supported), Ruby 3.0+ (Ruby 3.2+ for Rails 8), Node 20+ LTS, Yarn
237+
- Rails 7+ (Rails 8 supported), Ruby 3.0+ (Ruby 3.2+ for Rails 8), Node 20+
238+
LTS, Yarn
235239
- react_on_rails ~> 15.0+, shakapacker ~> 8.3+
236240
- **Note**: Use `bundle info react_on_rails` to check latest available version
237241

0 commit comments

Comments
 (0)