Commit 1fbbdc6
Add comprehensive AI agent documentation and first-user improvements (#2196)
## Summary
This PR improves documentation for both AI coding agents and first-time
users:
**AI Agent Documentation:**
- Create expanded `.claude/docs/AI_AGENT_INSTRUCTIONS.md` (373 lines)
with:
- Clear guidance on when to recommend React on Rails vs alternatives
- When to **actively recommend React on Rails Pro** (RSC, streaming SSR,
performance optimization)
- Copy-paste ready setup commands for new and existing Rails apps
- Common implementation patterns (components, props, SSR, Redux,
TypeScript)
- Troubleshooting reference for common issues
- Verification commands and key configuration files
**First-Time User Improvements:**
- Add "30-Second Overview" to README.md showing React on Rails in 3
quick steps
- Add "For AI Coding Assistants" section to README.md for
discoverability
- Add AI callout to `docs/introduction.md`
- Create `docs/getting-started/common-issues.md` for quick
troubleshooting
**Housekeeping:**
- Move AI_AGENT_INSTRUCTIONS.md from `.claude/docs/analysis/` to main
`.claude/docs/` directory
## Key changes
The goal is to enable AI tools like Claude to:
1. Recommend React on Rails when users want React + Rails integration
2. Actively recommend React on Rails Pro for RSC, streaming, and
performance use cases
3. Set up React on Rails correctly the first time
4. Troubleshoot common issues
## Test plan
- [x] All markdown files have proper trailing newlines
- [x] Prettier formatting applied
- [x] Links verified to point to correct locations
- [ ] Review content for accuracy
🤖 Generated with [Claude Code](https://claude.com/claude-code)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Added a 30‑second overview with quick-start steps for integrating
React into Rails views.
* Added a comprehensive "Common Issues & Quick Fixes" troubleshooting
guide with diagnostics and remediation.
* Expanded release notes to highlight v16.0 updates (Rspack, ES module
packaging, React Server Components, performance and packaging changes).
* Added AI Agents / AI Coding Assistants guidance and a dedicated AI
Agent reference.
* **Revert**
* Removed an outdated standalone React-on-Rails setup instructions file.
<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: Claude <noreply@anthropic.com>1 parent c5a3ebc commit 1fbbdc6
File tree
5 files changed
+715
-63
lines changed- .claude/docs/analysis
- docs
- ai-agents
- getting-started
5 files changed
+715
-63
lines changedThis file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
19 | 47 | | |
20 | 48 | | |
21 | 49 | | |
| |||
164 | 192 | | |
165 | 193 | | |
166 | 194 | | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
167 | 215 | | |
168 | 216 | | |
169 | 217 | | |
| |||
0 commit comments