Skip to content

Commit 8cb6ede

Browse files
ihabadhamclaude
andcommitted
Delete outdated manual-installation-overview.md
Rationale: - File has been outdated since 2018 (had "TODO: Review this file" for 7 years) - Confused purpose: title says "Manual Installation" but subtitle says "summarizes what generator does" - Outdated content: references /client directory, webpacker, missing auto-bundling - No clear use case: rails generate react_on_rails:install IS the manual installation (not external CLI like create-react-app) - Content is better covered in: - how-react-on-rails-works.md (architecture) - using-react-on-rails.md (usage) - Generator source code (what files are created) Changes: - Deleted docs/advanced-topics/manual-installation-overview.md - Removed link in installation-into-an-existing-rails-app.md - Updated ia-redesign-live.md tracker Decision discussed with team in Slack. Can be reverted if use case is identified. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 06ba02d commit 8cb6ede

File tree

3 files changed

+12
-37
lines changed

3 files changed

+12
-37
lines changed

docs/advanced-topics/manual-installation-overview.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/getting-started/installation-into-an-existing-rails-app.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,6 @@
5454

5555
## Installation
5656

57-
See the [Installation Overview](../advanced-topics/manual-installation-overview.md) for a concise set summary of what's in a React on Rails installation.
58-
5957
## NPM
6058

6159
All JavaScript in React On Rails is loaded from npm: [react-on-rails](https://www.npmjs.com/package/react-on-rails). To manually install this (you did not use the generator), assuming you have a standard configuration, run this command (assuming you are in the directory where you have your `node_modules`):

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

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -374,13 +374,19 @@ After Steps 1-8, found 12 files not in original plan. Investigated and reorganiz
374374
- No unique content lost
375375

376376
6. **✅ Transformed `docs/getting-started.md``docs/getting-started/using-react-on-rails.md`**
377+
377378
- Reduced from 253 to 238 lines (still comprehensive but focused)
378379
- Removed: Choose Starting Point (redundant), System Requirements (duplicate), More Reading (navigation)
379380
- Transformed installation section to conceptual overview with links
380-
- Kept: Basic Usage, Auto-Bundling concept, Render-Functions concept, Error Handling
381-
- Added: Clear "Next Steps" section with organized paths
382-
- Purpose: Conceptual journey guide explaining how things work (not step-by-step tutorial)
383-
- Updated link in quick-start.md
381+
382+
7. **✅ Deleted `docs/advanced-topics/manual-installation-overview.md`**
383+
- Outdated since 2018 (had "TODO: Review this file" for 7 years)
384+
- Confused purpose: title said "Manual Installation" but subtitle said "summarizes what generator does"
385+
- Outdated content: referenced `/client`, `webpacker`, missing auto-bundling
386+
- No clear use case: generator IS the manual installation (not external CLI)
387+
- Content better covered in: how-react-on-rails-works.md, using-react-on-rails.md
388+
- Removed link from installation-into-an-existing-rails-app.md
389+
- Decision discussed with team in Slack
384390
- Deleted original `docs/getting-started.md`
385391

386392
**Remaining Entry Point Tasks:**
@@ -467,9 +473,8 @@ docs/
467473
│ ├── doctrine.md
468474
│ ├── style.md
469475
│ └── tips.md
470-
└── advanced-topics/ (2 files - KEEPING as category)
471-
├── rails-engine-integration.md # Step 5 correction: from deployment
472-
└── manual-installation-overview.md # Orphaned: manual setup guide
476+
└── advanced-topics/ (1 file - KEEPING as category)
477+
└── rails-engine-integration.md # Step 5 correction: from deployment
473478
```
474479

475480
**Final Decisions:**

0 commit comments

Comments
 (0)