Skip to content

Commit c5b1583

Browse files
ihabadhamclaude
andcommitted
Rename understanding-react-on-rails.md to using-react-on-rails.md
Rationale: - "understanding" is vague and confusing next to how-react-on-rails-works.md - "using" clearly indicates practical usage guide - Better distinction: how-react-on-rails-works.md (architecture) vs using-react-on-rails.md (practical usage) Changes: - Renamed docs/getting-started/understanding-react-on-rails.md → using-react-on-rails.md - Updated link in quick-start.md - Updated references in ia-redesign-live.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 38fe50f commit c5b1583

File tree

3 files changed

+9
-3
lines changed

3 files changed

+9
-3
lines changed

docs/getting-started/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ Now that you have React on Rails working, here's what to explore next:
159159

160160
### Immediate Next Steps
161161

162-
1. **[Understanding React on Rails](./understanding-react-on-rails.md)** - Core concepts explained
162+
1. **[Using React on Rails](./using-react-on-rails.md)** - Core concepts explained
163163
2. **[View Helpers API](../api-reference/view-helpers-api.md)** - Learn all the options for `react_component`
164164
3. **[Hot Module Replacement](../building-features/hmr-and-hot-reloading-with-the-webpack-dev-server.md)** - Optimize your dev workflow
165165

File renamed without changes.

docs/planning/docs-improvement/ia-redesign-live.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -330,11 +330,13 @@ After Steps 1-8, found 12 files not in original plan. Investigated and reorganiz
330330
### Actions Completed:
331331

332332
1. **✅ Deleted orphaned `docs/guides/advanced/README.md`**
333+
333334
- Navigation index left behind after reorganization
334335
- Linked to files now in core-concepts/
335336
- Redundant, deleted
336337

337338
2. **✅ Created `docs/introduction.md`** - New unified homepage
339+
338340
- Explains what React on Rails is and why use it
339341
- When to use / when not to use decision guide
340342
- Three clear paths: Quick Start, Installation, Tutorial
@@ -348,12 +350,14 @@ After Steps 1-8, found 12 files not in original plan. Investigated and reorganiz
348350
- Built from: overview.md, doctrine.md, README.md structure
349351

350352
3. **✅ Deleted `docs/core-concepts/react-on-rails-overview.md`**
353+
351354
- Content consolidated into introduction.md
352355
- Outdated prerequisites (Rails >=5 vs current Rails 7+)
353356
- Created confusion with two similar entry points
354357
- Updated 2 links: home.md and doctrine.md
355358

356359
4. **✅ Simplified `docs/README.md`** for GitHub users
360+
357361
- Reduced from 173 lines to 65 lines
358362
- Directs to website first
359363
- Kept valuable learning paths from PR #1813
@@ -363,12 +367,13 @@ After Steps 1-8, found 12 files not in original plan. Investigated and reorganiz
363367
- Purpose: Serves GitHub users browsing repo, not website visitors
364368

365369
5. **✅ Deleted `docs/home.md`**
370+
366371
- Was the current website homepage (29 lines of links)
367372
- Replaced by introduction.md
368373
- All valuable content already in introduction.md or README.md
369374
- No unique content lost
370375

371-
6. **✅ Transformed `docs/getting-started.md``docs/getting-started/understanding-react-on-rails.md`**
376+
6. **✅ Transformed `docs/getting-started.md``docs/getting-started/using-react-on-rails.md`**
372377
- Reduced from 253 to 238 lines (still comprehensive but focused)
373378
- Removed: Choose Starting Point (redundant), System Requirements (duplicate), More Reading (navigation)
374379
- Transformed installation section to conceptual overview with links
@@ -379,6 +384,7 @@ After Steps 1-8, found 12 files not in original plan. Investigated and reorganiz
379384
- Deleted original `docs/getting-started.md`
380385

381386
**Remaining Entry Point Tasks:**
387+
382388
- Update website config (sc-website gatsby-node.js) to use introduction.md as homepage
383389

384390
**Next Actions:** Update website config when ready (keeping for last as user requested)
@@ -392,7 +398,7 @@ docs/
392398
├── introduction.md # ✅ Created - new unified homepage
393399
├── README.md # ✅ Simplified for GitHub users
394400
├── getting-started/ (5 files)
395-
│ ├── understanding-react-on-rails.md # ✅ NEW - Transformed from getting-started.md
401+
│ ├── using-react-on-rails.md # ✅ NEW - Transformed from getting-started.md
396402
│ ├── quick-start.md
397403
│ ├── installation-into-an-existing-rails-app.md
398404
│ ├── tutorial.md

0 commit comments

Comments
 (0)